GET
/
files
/
v3
/
folders
/
search
Buscar carpetas
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"
    }
  ]
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubStarter

Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • 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[]

Propiedades que deben incluirse en las carpetas devueltas.

after
string

Desplaza los resultados de la búsqueda en este valor. El desplazamiento predeterminado es 0 y el desplazamiento máximo de elementos para una búsqueda determinada es de 10.000. Reduce la búsqueda si llegas a este límite.

before
string
limit
integer

Número de elementos que se devolverán. El límite predeterminado es 10, el límite máximo es 100.

sort
string[]

Clasificar los resultados por la propiedad dada. Por ejemplo, clasificación de nombres por campo de nombre en orden descendente, clasificación de nombres por campo de nombre en orden ascendente.

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

Buscar carpetas por hora exacta de creación. La hora debe ser la hora en milisegundos de Epoch.

createdAtLte
string<date-time>

Buscar carpetas por menos o igual a la hora de creación. Se puede utilizar con createdAtGte para crear un rango.

createdAtGte
string<date-time>

Buscar carpetas por mayor o igual a la hora de creación. Se puede utilizar con createdAtLte para crear un rango.

updatedAt
string<date-time>

Buscar carpetas por hora exacta de la última actualización. La hora debe ser la hora en milisegundos de Epoch.

updatedAtLte
string<date-time>

Buscar carpetas por menos o igual a la hora de última actualización. Se puede utilizar con updatedAtGte para crear un rango.

updatedAtGte
string<date-time>

Buscar carpetas por mayor o igual a la hora de última actualización. Se puede utilizar con updatedAtLte para crear un rango.

name
string

Buscar carpetas que contengan el nombre especificado.

path
string

Buscar carpetas por ruta.

parentFolderIds
integer[]

Buscar carpetas con el folderId principal dado.

Response

200
application/json

successful operation

The response is of type object.