GET
/
files
/
v3
/
folders
/
search
Rechercher des dossiers
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"
    }
  ]
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubStarter

Portées requises

Cette API requiert l’une des portées suivantes :
  • 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[]

Propriétés qui doivent être incluses dans les dossiers retournés.

after
string

Décaler les résultats de la recherche de cette valeur. Le décalage par défaut est de 0 et le décalage maximal des éléments pour une recherche donnée est de 10 000. Limitez votre recherche si vous atteignez cette limite.

before
string
limit
integer

Nombre d'éléments à renvoyer. La limite par défaut est de 10, la limite maximale est de 100.

sort
string[]

Trier les résultats selon la propriété donnée. Par exemple, -trier les noms par champ de noms décroissant, trier les noms par champ de noms croissant.

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

Recherche de dossiers en fonction de l'heure exacte de leur création. L'heure doit être l'heure d'origine en millisecondes.

createdAtLte
string<date-time>

Recherche de dossiers par date de création inférieure ou égale. Peut être utilisé avec createdAtGte pour créer une plage.

createdAtGte
string<date-time>

Recherche de dossiers par date de création supérieure ou égale. Peut être utilisé avec createdAtLte pour créer une plage.

updatedAt
string<date-time>

Recherche de dossiers en fonction de l'heure exacte de la dernière mise à jour. L'heure doit être l'heure d'origine en millisecondes.

updatedAtLte
string<date-time>

Recherche de dossiers par date inférieure ou égale à la date de la dernière mise à jour. Peut être utilisé avec updatedAtGte pour créer une plage.

updatedAtGte
string<date-time>

Recherche les dossiers en fonction de l'heure de la dernière mise à jour. Peut être utilisé avec updatedAtLte pour créer une plage.

name
string

Rechercher des dossiers contenant le nom spécifié.

path
string

Recherche de dossiers par chemin d'accès.

parentFolderIds
integer[]

Recherche les dossiers dont le folderId parent est donné.

Response

200
application/json

successful operation

The response is of type object.