GET
/
files
/
v3
/
folders
/
search
Pesquisar pastas
curl --request GET \
  --url https://api.hubapi.com/files/v3/folders/search \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    },
    "prev": {
      "before": "",
      "link": ""
    }
  },
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "path": "<string>",
      "archived": true,
      "parentFolderId": "<string>",
      "name": "<string>",
      "id": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubStarter

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • files.ui_hidden.read
  • files

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
properties
string[]

Propriedades que devem ser incluídas nas pastas retornadas.

​
after
string

Compense os resultados da pesquisa por este valor. A compensação padrão é 0, e o máximo de itens para uma determinada pesquisa é 10.000. Reduza sua pesquisa se você atingir esse limite.

​
before
string
​
limit
integer

Número de itens a serem retornados. O limite padrão é 10, o limite máximo é 100.

​
sort
string[]

Classifique os resultados pela propriedade especificado. Por exemplo, -name classifica pelo campo de nome em ordem decrescente; name classifica pelo campo de nome em ordem crescente.

​
ids
integer[]
​
idLte
integer
​
idGte
integer
​
createdAt
string<date-time>

Pesquise pastas pela hora exata de criação. A hora deve estar em milissegundos de época.

​
createdAtLte
string<date-time>

Pesquise pastas por hora menor ou igual à hora de criação. Pode ser usado com createdAtGte para criar um intervalo.

​
createdAtGte
string<date-time>

Pesquise pastas por hora maior ou igual à hora de criação. Pode ser usado com createdAtLte para criar um intervalo.

​
updatedAt
string<date-time>

Pesquise pastas pela hora exata da última atualização. A hora deve estar em milissegundos de época.

​
updatedAtLte
string<date-time>

Pesquise pastas por hora menor ou igual à hora da última atualização. Pode ser usado com updatedAtGte para criar um intervalo.

​
updatedAtGte
string<date-time>

Pesquise pastas por hora maior ou igual à hora da última atualização. Pode ser usado com updatedAtLte para criar um intervalo.

​
name
string

Pesquise pastas que contêm o nome especificado.

​
path
string

Pesquise pastas por caminho.

​
parentFolderIds
integer[]

Pesquise pastas com o folderId principal especificado.

Response

200
application/json

successful operation

The response is of type object.