GET/v1/folders
Obține arborii de dosare ai tuturor colecțiilor
folder_trees
Returnează, într-un singur răspuns, arborii de dosare ai tuturor colecțiilor în care utilizatorul vede cel puțin un obiect, cu aceleași reguli de vizibilitate ca GET /v1/collections/{name}/folders și în ordinea din GET /v1/collections. O colecție fără obiecte vizibile este omisă. Pe lângă cards, fiecare dosar are totalurile subarborelui cards_total, sensitive_total și top_category. Cu updated_since sau metadata[<key>]=, folders din fiecare colecție conține dosarele potrivite ca listă simplă (children este gol, iar parent_id indică locul în arbore). Cu updated_since, ele sunt sortate după updated_at crescător, apoi după id; fără el, în ordinea sort_key. Colecțiile fără dosare potrivite sunt omise.
Autentificare
Trimiteți o cheie API în antetul Authorization: Authorization: Bearer <cheie>.
Parametri de interogare
limitintegerDimensiunea paginii. Fără
limitșicursorse returnează întreaga listă; dacă este setat, cel multlimitelemente, iar pagina următoare este indicată în anteteleLink(rel="next") șiX-Next-Cursor.≥ 1, ≤ 200
cursorstringCursorul paginii următoare din
X-Next-Cursorsaunext_cursoral răspunsului anterior, cu aceleași filtre; el conține dimensiunea paginii. Împreună cuoffset:422 validation.failed; un cursor al altei liste, cu alte filtre sau malformat:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Doar obiectele cu
updated_ategal cu acest moment sau ulterior lui (RFC 3339 cu decalajul fusului orar), pentru sincronizare. Cu el, lista este sortată dupăupdated_atcrescător, apoi dupăid, iar cursorul continuă în această ordine. Obiectele șterse nu sunt listate: ștergerile vin ca evenimente.length ≤ 512
metadatamap of stringFiltru după
metadata:metadata[<key>]=<value>caută potrivirea exactă. Cel mult 3 condiții, care trebuie îndeplinite toate (?metadata[team]=support&metadata[crm_id]=A-1042). Mai mult de 3 condiții sau o cheie invalidă returnează400 api.metadata_invalid.
Răspunsuri
200Răspuns reușit
Antetele răspunsului
LinkAdresa paginii următoare,
<…>; rel="next". Lipsa antetului înseamnă că aceasta este ultima pagină.X-Next-CursorCursorul paginii următoare pentru parametrul
cursor. Lipsa antetului înseamnă că aceasta este ultima pagină.RateLimit-PolicyLimitele în vigoare, în formatul proiectului IETF
draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă"<name>";q=<quota>;w=<window in seconds>.keyeste frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune esteuser, fără date de autentificareip);minute,dayșimonthsunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.RateLimitCât a rămas din fiecare limită din
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimita celei mai stricte intrări din
RateLimit-Policy(cea cu cele mai puține cereri rămase).X-RateLimit-RemainingCereri rămase în cadrul celei mai stricte limite.
X-RateLimit-ResetSecunde până la resetarea celei mai stricte limite.
application/json
collection_idintegerobligatoriucollection_namestringobligatoriucollection_titlestringobligatoriuNumele colecției pentru afișare.
permissionsarray of stringobligatoriuPermisiunile efective ale utilizatorului asupra colecției.
unfiledintegerobligatoriuFișele colecției disponibile utilizatorului care nu se află în niciun dosar. Fișele arhivate nu se numără, ca în lista implicită a fișelor.
401Nu au fost trimise date de autentificare (nici cookie de sesiune, nici cheie API) sau cheia nu a fost găsită.
Antetele răspunsului
RateLimit-PolicyLimitele în vigoare, în formatul proiectului IETF
draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă"<name>";q=<quota>;w=<window in seconds>.keyeste frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune esteuser, fără date de autentificareip);minute,dayșimonthsunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.RateLimitCât a rămas din fiecare limită din
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimita celei mai stricte intrări din
RateLimit-Policy(cea cu cele mai puține cereri rămase).X-RateLimit-RemainingCereri rămase în cadrul celei mai stricte limite.
X-RateLimit-ResetSecunde până la resetarea celei mai stricte limite.
application/json
429Prea multe cereri (`api.rate_limited`), cota organizației pentru minut, zi sau lună este epuizată (`api.quota_exceeded`; `error.details` conține `quota`, `limit` și `reset_at`), limita organizației este atinsă sau serviciul de răspunsuri este ocupat (`answers.engine_busy`). Așteptați timpul indicat în antetul `Retry-After`.
Antetele răspunsului
Retry-AfterNumărul de secunde de așteptat înainte de a reîncerca cererea.
RateLimit-PolicyLimitele în vigoare, în formatul proiectului IETF
draft-ietf-httpapi-ratelimit-headers: elemente separate prin virgulă"<name>";q=<quota>;w=<window in seconds>.keyeste frecvența cererilor cheii API (cota este rafala, fereastra este timpul în care rafala se reface complet; pentru o sesiune esteuser, fără date de autentificareip);minute,dayșimonthsunt cotele organizației pentru minutul, ziua și luna calendaristice în UTC.RateLimitCât a rămas din fiecare limită din
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimita celei mai stricte intrări din
RateLimit-Policy(cea cu cele mai puține cereri rămase).X-RateLimit-RemainingCereri rămase în cadrul celei mai stricte limite.
X-RateLimit-ResetSecunde până la resetarea celei mai stricte limite.
application/json
Coduri de eroare
Codurile pe care acest endpoint le poate returna în error.code, pe lângă codurile generale ale oricărei cereri.
Limite de frecvență
Răspunsurile conțin antetele RateLimit și RateLimit-Policy, precum și antetele anterioare X-RateLimit-Limit, X-RateLimit-Remaining și X-RateLimit-Reset. Un răspuns 429 conține Retry-After în secunde: așteptați și reîncercați.