Vai al contenuto
Sursa Developers

GET/v1/folders

Ottenere gli alberi delle cartelle di tutte le raccolte

folder_trees

Restituisce, in una sola risposta, gli alberi delle cartelle di tutte le raccolte in cui l’utente può vedere almeno un oggetto, con le stesse regole di visibilità di GET /v1/collections/{name}/folders e nell’ordine di GET /v1/collections. Una raccolta senza oggetti visibili viene esclusa. Oltre a cards, ogni cartella ha i totali del sottoalbero cards_total, sensitive_total e top_category. Con updated_since o metadata[<key>]=, i folders di ogni raccolta contengono le cartelle corrispondenti come elenco piatto (children è vuoto e parent_id indica la posizione nell’albero). Con updated_since sono ordinate per updated_at crescente, poi per id; senza, nell’ordine di sort_key. Le raccolte senza cartelle corrispondenti vengono escluse.

Autenticazione

Invia una chiave API nell’intestazione Authorization: Authorization: Bearer <chiave>.

Parametri di query

  • limitinteger

    Dimensione della pagina. Senza limit e cursor viene restituito l’elenco intero; con questo parametro, al massimo limit elementi, e la pagina successiva è indicata nelle intestazioni Link (rel="next") e X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Cursore della pagina successiva, preso da X-Next-Cursor o da next_cursor della risposta precedente con gli stessi filtri; contiene la dimensione della pagina. Insieme a offset: 422 validation.failed; un cursore di un altro elenco, con altri filtri o malformato: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Solo gli oggetti con updated_at uguale o successivo a questo momento (RFC 3339 con offset), per la sincronizzazione. Con questo parametro, l’elenco è ordinato per updated_at crescente, poi per id, e il cursore prosegue in quell’ordine. Gli oggetti eliminati non compaiono nell’elenco: le eliminazioni arrivano come eventi.

    length ≤ 512

  • metadatamap of string

    Filtro per metadata: metadata[<key>]=<value> corrisponde in modo esatto. Fino a 3 condizioni, che devono essere soddisfatte tutte (?metadata[team]=support&metadata[crm_id]=A-1042). Più di 3 condizioni o una chiave non valida restituiscono 400 api.metadata_invalid.

Risposte

200Risposta riuscita

Intestazioni della risposta

  • Link

    Indirizzo della pagina successiva, <…>; rel="next". Se l’intestazione manca, questa è l’ultima pagina.

  • X-Next-Cursor

    Cursore della pagina successiva per il parametro cursor. Se l’intestazione manca, questa è l’ultima pagina.

  • RateLimit-Policy

    Limiti in vigore, nel formato della bozza IETF draft-ietf-httpapi-ratelimit-headers: elementi separati da virgole "<name>";q=<quota>;w=<window in seconds>. key è la frequenza delle richieste della chiave API (la quota è il burst, la finestra è il tempo necessario a ricaricarla completamente; per una sessione è user, senza credenziali ip); minute, day e month sono le quote dell’organizzazione per il minuto, il giorno e il mese di calendario in UTC.

  • RateLimit

    Quanto resta di ciascun limite di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limite della voce più restrittiva di RateLimit-Policy (quella con meno richieste rimanenti).

  • X-RateLimit-Remaining

    Richieste rimanenti nel limite più restrittivo.

  • X-RateLimit-Reset

    Secondi che mancano all’azzeramento del limite più restrittivo.

application/json

Oggetto: FolderTreeList

array of FolderTree
  • collection_idintegerobbligatorio
  • collection_namestringobbligatorio
  • collection_titlestringobbligatorio

    Nome della raccolta da visualizzare.

  • permissionsarray of stringobbligatorio

    I permessi effettivi dell’utente sulla raccolta.

  • unfiledintegerobbligatorio

    Schede della raccolta disponibili all’utente che non sono in nessuna cartella. Le schede archiviate non vengono conteggiate, come nell’elenco predefinito delle schede.

  • foldersarray of FolderNodeobbligatorio
401Non sono state inviate credenziali (né un cookie di sessione né una chiave API), oppure la chiave non è stata trovata.

Intestazioni della risposta

  • RateLimit-Policy

    Limiti in vigore, nel formato della bozza IETF draft-ietf-httpapi-ratelimit-headers: elementi separati da virgole "<name>";q=<quota>;w=<window in seconds>. key è la frequenza delle richieste della chiave API (la quota è il burst, la finestra è il tempo necessario a ricaricarla completamente; per una sessione è user, senza credenziali ip); minute, day e month sono le quote dell’organizzazione per il minuto, il giorno e il mese di calendario in UTC.

  • RateLimit

    Quanto resta di ciascun limite di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limite della voce più restrittiva di RateLimit-Policy (quella con meno richieste rimanenti).

  • X-RateLimit-Remaining

    Richieste rimanenti nel limite più restrittivo.

  • X-RateLimit-Reset

    Secondi che mancano all’azzeramento del limite più restrittivo.

application/json

Oggetto: Error

429Troppe richieste (`api.rate_limited`), la quota dell’organizzazione per il minuto, il giorno o il mese è esaurita (`api.quota_exceeded`; `error.details` contiene `quota`, `limit` e `reset_at`), è stato raggiunto il limite dell’organizzazione, oppure il servizio delle risposte è occupato (`answers.engine_busy`). Attendi il tempo indicato nell’intestazione `Retry-After`.

Intestazioni della risposta

  • Retry-After

    Numero di secondi da attendere prima di ripetere la richiesta.

  • RateLimit-Policy

    Limiti in vigore, nel formato della bozza IETF draft-ietf-httpapi-ratelimit-headers: elementi separati da virgole "<name>";q=<quota>;w=<window in seconds>. key è la frequenza delle richieste della chiave API (la quota è il burst, la finestra è il tempo necessario a ricaricarla completamente; per una sessione è user, senza credenziali ip); minute, day e month sono le quote dell’organizzazione per il minuto, il giorno e il mese di calendario in UTC.

  • RateLimit

    Quanto resta di ciascun limite di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limite della voce più restrittiva di RateLimit-Policy (quella con meno richieste rimanenti).

  • X-RateLimit-Remaining

    Richieste rimanenti nel limite più restrittivo.

  • X-RateLimit-Reset

    Secondi che mancano all’azzeramento del limite più restrittivo.

application/json

Oggetto: Error

Codici di errore

Codici che questo endpoint può restituire in error.code, oltre ai codici generali di ogni richiesta.

Limiti di frequenza

Le risposte contengono le intestazioni RateLimit e RateLimit-Policy e le precedenti X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset. Una risposta 429 contiene Retry-After in secondi: attendi e riprova.

← folders · Riferimento API