Anar al contingut
Sursa Developers

GET/v1/folders

Obtenir els arbres de carpetes de totes les col·leccions

folder_trees

Retorna, en una sola resposta, els arbres de carpetes de totes les col·leccions on l’usuari pot veure com a mínim un objecte, amb les mateixes regles de visibilitat que GET /v1/collections/{name}/folders i en l’ordre de GET /v1/collections. Una col·lecció sense objectes visibles queda fora. A més de cards, cada carpeta té els totals del subarbre cards_total, sensitive_total i top_category. Amb updated_since o metadata[<key>]=, el folders de cada col·lecció conté les carpetes que coincideixen en una llista plana (children és buit, i parent_id indica el lloc a l’arbre). Amb updated_since, s’ordenen per updated_at en ordre ascendent i després per id; sense aquest paràmetre, en l’ordre de sort_key. Les col·leccions sense carpetes que coincideixin queden fora.

Autenticació

Envieu una clau d’API a la capçalera Authorization: Authorization: Bearer <clau>.

Paràmetres de consulta

  • limitinteger

    Mida de pàgina. Sense limit ni cursor es retorna la llista sencera; amb aquest paràmetre, com a màxim limit elements, i la pàgina següent s’indica a les capçaleres Link (rel="next") i X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Cursor de la pàgina següent, de X-Next-Cursor o del next_cursor de la resposta anterior amb els mateixos filtres; porta la mida de pàgina. Juntament amb offset: 422 validation.failed; un cursor d’una altra llista, d’altres filtres o mal format: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Només els objectes amb updated_at igual o posterior a aquest moment (RFC 3339 amb desplaçament horari), per a la sincronització. Amb aquest paràmetre, la llista s’ordena per updated_at en ordre ascendent i després per id, i el cursor continua en aquest ordre. Els objectes eliminats no es llisten: les eliminacions arriben com a esdeveniments.

    length ≤ 512

  • metadatamap of string

    Filtre per metadata: metadata[<key>]=<value> coincideix exactament. Fins a 3 condicions, i s’han de complir totes (?metadata[team]=support&metadata[crm_id]=A-1042). Més de 3 condicions o una clau no vàlida retornen 400 api.metadata_invalid.

Respostes

200Resposta correcta

Capçaleres de la resposta

  • Link

    Adreça de la pàgina següent, <…>; rel="next". Si no hi ha capçalera, aquesta és l’última pàgina.

  • X-Next-Cursor

    Cursor de la pàgina següent per al paràmetre cursor. Si no hi ha capçalera, aquesta és l’última pàgina.

  • RateLimit-Policy

    Límits vigents, en el format de l’esborrany de l’IETF draft-ietf-httpapi-ratelimit-headers: elements separats per comes "<name>";q=<quota>;w=<window in seconds>. key és la freqüència de sol·licituds de la clau d’API (la quota és la ràfega, la finestra és el temps que triga a reomplir-se del tot; per a una sessió és user, sense credencials ip); minute, day i month són les quotes de l’organització per al minut, el dia i el mes naturals en UTC.

  • RateLimit

    El que queda de cada límit de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Límit de l’element més restrictiu de RateLimit-Policy (el que té menys sol·licituds restants).

  • X-RateLimit-Remaining

    Sol·licituds restants dins del límit més restrictiu.

  • X-RateLimit-Reset

    Segons que falten perquè es restableixi el límit més restrictiu.

application/json

Objecte: FolderTreeList

array of FolderTree
  • collection_idintegerobligatori
  • collection_namestringobligatori
  • collection_titlestringobligatori

    Nom de la col·lecció per mostrar.

  • permissionsarray of stringobligatori

    Permisos efectius de l’usuari sobre la col·lecció.

  • unfiledintegerobligatori

    Entrades de la col·lecció disponibles per a l’usuari que no són a cap carpeta. Les entrades arxivades no es compten, com a la llista d’entrades per defecte.

  • foldersarray of FolderNodeobligatori
401No s’han enviat credencials (ni una galeta de sessió ni una clau d’API), o no s’ha trobat la clau.

Capçaleres de la resposta

  • RateLimit-Policy

    Límits vigents, en el format de l’esborrany de l’IETF draft-ietf-httpapi-ratelimit-headers: elements separats per comes "<name>";q=<quota>;w=<window in seconds>. key és la freqüència de sol·licituds de la clau d’API (la quota és la ràfega, la finestra és el temps que triga a reomplir-se del tot; per a una sessió és user, sense credencials ip); minute, day i month són les quotes de l’organització per al minut, el dia i el mes naturals en UTC.

  • RateLimit

    El que queda de cada límit de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Límit de l’element més restrictiu de RateLimit-Policy (el que té menys sol·licituds restants).

  • X-RateLimit-Remaining

    Sol·licituds restants dins del límit més restrictiu.

  • X-RateLimit-Reset

    Segons que falten perquè es restableixi el límit més restrictiu.

application/json

Objecte: Error

429Massa sol·licituds (`api.rate_limited`), s’ha esgotat la quota de l’organització per al minut, el dia o el mes (`api.quota_exceeded`; `error.details` conté `quota`, `limit` i `reset_at`), s’ha arribat al límit de l’organització o el servei de respostes està ocupat (`answers.engine_busy`). Espereu el temps que indica la capçalera `Retry-After`.

Capçaleres de la resposta

  • Retry-After

    Nombre de segons que cal esperar abans de reintentar la sol·licitud.

  • RateLimit-Policy

    Límits vigents, en el format de l’esborrany de l’IETF draft-ietf-httpapi-ratelimit-headers: elements separats per comes "<name>";q=<quota>;w=<window in seconds>. key és la freqüència de sol·licituds de la clau d’API (la quota és la ràfega, la finestra és el temps que triga a reomplir-se del tot; per a una sessió és user, sense credencials ip); minute, day i month són les quotes de l’organització per al minut, el dia i el mes naturals en UTC.

  • RateLimit

    El que queda de cada límit de RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Límit de l’element més restrictiu de RateLimit-Policy (el que té menys sol·licituds restants).

  • X-RateLimit-Remaining

    Sol·licituds restants dins del límit més restrictiu.

  • X-RateLimit-Reset

    Segons que falten perquè es restableixi el límit més restrictiu.

application/json

Objecte: Error

Codis d’error

Codis que aquest punt final pot retornar a error.code, a més dels codis generals de totes les sol·licituds.

Límits de freqüència

Les respostes porten les capçaleres RateLimit i RateLimit-Policy i les anteriors X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Una resposta 429 té Retry-After en segons: espereu i torneu-ho a provar.

← folders · Referència de l’API