GET/v1/folders
Získať stromy priečinkov všetkých kolekcií
folder_trees
Vráti v jednej odpovedi stromy priečinkov všetkých kolekcií, v ktorých používateľ vidí aspoň jeden objekt, s rovnakými pravidlami viditeľnosti ako GET /v1/collections/{name}/folders a v poradí podľa GET /v1/collections. Kolekcia bez viditeľných objektov sa vynechá. Okrem cards má každý priečinok súčty podstromu cards_total, sensitive_total a top_category. S updated_since alebo metadata[<key>]= obsahujú folders každej kolekcie vyhovujúce priečinky ako plochý zoznam (children je prázdne a parent_id udáva miesto v strome). S updated_since sú zoradené podľa updated_at vzostupne, potom podľa id; bez neho v poradí podľa sort_key. Kolekcie bez vyhovujúcich priečinkov sa vynechajú.
Autentifikácia
Odošlite kľúč API v hlavičke Authorization: Authorization: Bearer <kľúč>.
Parametre dotazu
limitintegerVeľkosť stránky. Bez
limitacursorsa vráti celý zoznam; s ním najviaclimitpoložiek a ďalšia stránka je uvedená v hlavičkáchLink(rel="next") aX-Next-Cursor.≥ 1, ≤ 200
cursorstringKurzor ďalšej stránky z
X-Next-Cursoralebo znext_cursorpredchádzajúcej odpovede s rovnakými filtrami; nesie aj veľkosť stránky. Spolu soffset:422 validation.failed; kurzor iného zoznamu, s inými filtrami alebo poškodený:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Len objekty s
updated_atv tomto okamihu alebo neskôr (RFC 3339 s časovým posunom), na synchronizáciu. S ním je zoznam zoradený podľaupdated_atvzostupne, potom podľaid, a kurzor pokračuje v tomto poradí. Odstránené objekty sa v zozname neuvádzajú: odstránenia prichádzajú ako udalosti.length ≤ 512
metadatamap of stringFilter podľa
metadata:metadata[<key>]=<value>vyžaduje presnú zhodu. Najviac 3 podmienky, pričom musia platiť všetky (?metadata[team]=support&metadata[crm_id]=A-1042). Viac ako 3 podmienky alebo neplatný kľúč vráti400 api.metadata_invalid.
Odpovede
200Úspešná odpoveď
Hlavičky odpovede
LinkAdresa ďalšej stránky,
<…>; rel="next". Ak hlavička chýba, ide o poslednú stránku.X-Next-CursorKurzor ďalšej stránky pre parameter
cursor. Ak hlavička chýba, ide o poslednú stránku.RateLimit-PolicyPlatné limity vo formáte návrhu IETF
draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami"<name>";q=<quota>;w=<window in seconds>.keyje frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je touser, bez prihlasovacích údajovip);minute,dayamonthsú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.RateLimitČo zostáva z každého limitu v
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit najprísnejšej položky v
RateLimit-Policy(tej, ktorej zostáva najmenej požiadaviek).X-RateLimit-RemainingPočet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-ResetPočet sekúnd do obnovenia najprísnejšieho limitu.
application/json
collection_idintegerpovinnécollection_namestringpovinnécollection_titlestringpovinnéNázov kolekcie na zobrazenie.
permissionsarray of stringpovinnéEfektívne oprávnenia používateľa na kolekciu.
unfiledintegerpovinnéKarty kolekcie dostupné používateľovi, ktoré nie sú v žiadnom priečinku. Archivované karty sa nezapočítavajú, rovnako ako v predvolenom zozname kariet.
401Neboli odoslané žiadne prihlasovacie údaje (ani cookie relácie, ani kľúč API) alebo sa kľúč nenašiel.
Hlavičky odpovede
RateLimit-PolicyPlatné limity vo formáte návrhu IETF
draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami"<name>";q=<quota>;w=<window in seconds>.keyje frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je touser, bez prihlasovacích údajovip);minute,dayamonthsú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.RateLimitČo zostáva z každého limitu v
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit najprísnejšej položky v
RateLimit-Policy(tej, ktorej zostáva najmenej požiadaviek).X-RateLimit-RemainingPočet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-ResetPočet sekúnd do obnovenia najprísnejšieho limitu.
application/json
429Príliš veľa požiadaviek (`api.rate_limited`), vyčerpaná kvóta organizácie na minútu, deň alebo mesiac (`api.quota_exceeded`; `error.details` obsahuje `quota`, `limit` a `reset_at`), dosiahnutý limit organizácie alebo zaneprázdnená služba odpovedí (`answers.engine_busy`). Počkajte čas uvedený v hlavičke `Retry-After`.
Hlavičky odpovede
Retry-AfterPočet sekúnd, ktoré treba počkať pred opakovaním požiadavky.
RateLimit-PolicyPlatné limity vo formáte návrhu IETF
draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami"<name>";q=<quota>;w=<window in seconds>.keyje frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je touser, bez prihlasovacích údajovip);minute,dayamonthsú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.RateLimitČo zostáva z každého limitu v
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit najprísnejšej položky v
RateLimit-Policy(tej, ktorej zostáva najmenej požiadaviek).X-RateLimit-RemainingPočet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.
X-RateLimit-ResetPočet sekúnd do obnovenia najprísnejšieho limitu.
application/json
Chybové kódy
Kódy, ktoré táto operácia môže vrátiť v error.code, okrem všeobecných kódov každej požiadavky.
Limity frekvencie
Odpovede obsahujú hlavičky RateLimit a RateLimit-Policy a staršie X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Odpoveď 429 má hlavičku Retry-After v sekundách: počkajte a požiadavku zopakujte.