GET/v1/folders
Gauti visų rinkinių aplankų medžius
folder_trees
Viename atsake grąžina visų rinkinių, kuriuose naudotojas mato bent vieną objektą, aplankų medžius – su tomis pačiomis matomumo taisyklėmis kaip GET /v1/collections/{name}/folders ir GET /v1/collections tvarka. Rinkinys be matomų objektų praleidžiamas. Be cards, kiekvienas aplankas turi pomedžio sumas cards_total, sensitive_total ir top_category. Su updated_since arba metadata[<key>]= kiekvieno rinkinio lauke folders atitinkantys aplankai pateikiami plokščiu sąrašu (children tuščias, o parent_id nurodo vietą medyje). Su updated_since jie rikiuojami pagal updated_at didėjančia tvarka, paskui pagal id; be jo – sort_key tvarka. Rinkiniai be atitinkančių aplankų praleidžiami.
Autentifikavimas
Siųskite API raktą antraštėje Authorization: Authorization: Bearer <raktas>.
Užklausos parametrai
limitintegerPuslapio dydis. Be
limitircursorgrąžinamas visas sąrašas; su juo – ne daugiau kaiplimitelementų, o kitas puslapis nurodomas antraštėseLink(rel="next") irX-Next-Cursor.≥ 1, ≤ 200
cursorstringKito puslapio žymeklis iš
X-Next-Cursorarba iš ankstesnio atsako su tais pačiais filtrais laukonext_cursor; jame užkoduotas ir puslapio dydis. Kartu suoffset:422 validation.failed; kito sąrašo, kitų filtrų ar sugadintas žymeklis:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Tik objektai, kurių
updated_atne ankstesnis už šį momentą (RFC 3339 su laiko juostos poslinkiu); skirta sinchronizacijai. Su juo sąrašas rikiuojamas pagalupdated_atdidėjančia tvarka, paskui pagalid, o žymeklis tęsia ta pačia tvarka. Ištrinti objektai sąraše nepateikiami: apie ištrynimus pranešama įvykiais.length ≤ 512
metadatamap of stringFiltras pagal
metadata:metadata[<key>]=<value>tikrina tikslų atitikimą. Iki 3 sąlygų, ir visos jos turi būti tenkinamos (?metadata[team]=support&metadata[crm_id]=A-1042). Jei sąlygų daugiau nei 3 arba raktas netinkamas, grąžinama400 api.metadata_invalid.
Atsakai
200Sėkmingas atsakas
Atsako antraštės
LinkKito puslapio adresas,
<…>; rel="next". Jei antraštės nėra, tai paskutinis puslapis.X-Next-CursorKito puslapio žymeklis parametrui
cursor. Jei antraštės nėra, tai paskutinis puslapis.RateLimit-PolicyGaliojantys limitai IETF juodraščio
draft-ietf-httpapi-ratelimit-headersformatu: kableliais atskirti elementai"<name>";q=<quota>;w=<window in seconds>.key– API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai taiuser, be prisijungimo duomenų –ip);minute,dayirmonth– organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.RateLimitKiek liko kiekvieno
RateLimit-Policylimito:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGriežčiausio
RateLimit-Policyįrašo (kuriame liko mažiausiai užklausų) limitas.X-RateLimit-RemainingLikusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-ResetSekundės iki griežčiausio limito atsistatymo.
application/json
collection_idintegerprivalomascollection_namestringprivalomascollection_titlestringprivalomasRodomas rinkinio pavadinimas.
permissionsarray of stringprivalomasNaudotojo faktiniai leidimai rinkiniui.
unfiledintegerprivalomasNaudotojui prieinamos rinkinio kortelės, kurios nėra jokiame aplanke. Archyvuotos kortelės neskaičiuojamos, kaip ir numatytajame kortelių sąraše.
401Prisijungimo duomenys neišsiųsti (nei sesijos slapukas, nei API raktas) arba raktas nerastas.
Atsako antraštės
RateLimit-PolicyGaliojantys limitai IETF juodraščio
draft-ietf-httpapi-ratelimit-headersformatu: kableliais atskirti elementai"<name>";q=<quota>;w=<window in seconds>.key– API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai taiuser, be prisijungimo duomenų –ip);minute,dayirmonth– organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.RateLimitKiek liko kiekvieno
RateLimit-Policylimito:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGriežčiausio
RateLimit-Policyįrašo (kuriame liko mažiausiai užklausų) limitas.X-RateLimit-RemainingLikusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-ResetSekundės iki griežčiausio limito atsistatymo.
application/json
429Per daug užklausų (`api.rate_limited`), išnaudota organizacijos minutės, dienos ar mėnesio kvota (`api.quota_exceeded`; `error.details` pateikia `quota`, `limit` ir `reset_at`), pasiektas organizacijos limitas arba atsakymų paslauga užimta (`answers.engine_busy`). Palaukite tiek, kiek nurodyta antraštėje `Retry-After`.
Atsako antraštės
Retry-AfterKiek sekundžių palaukti prieš kartojant užklausą.
RateLimit-PolicyGaliojantys limitai IETF juodraščio
draft-ietf-httpapi-ratelimit-headersformatu: kableliais atskirti elementai"<name>";q=<quota>;w=<window in seconds>.key– API rakto užklausų dažnis (kvota – pliūpsnis, laiko langas – laikas, per kurį kvota visiškai atsistato; sesijai taiuser, be prisijungimo duomenų –ip);minute,dayirmonth– organizacijos kvotos kalendorinei minutei, dienai ir mėnesiui pagal UTC.RateLimitKiek liko kiekvieno
RateLimit-Policylimito:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGriežčiausio
RateLimit-Policyįrašo (kuriame liko mažiausiai užklausų) limitas.X-RateLimit-RemainingLikusių užklausų skaičius pagal griežčiausią limitą.
X-RateLimit-ResetSekundės iki griežčiausio limito atsistatymo.
application/json
Klaidų kodai
Kodai, kuriuos ši operacija gali grąžinti lauke error.code, be bendrųjų kodų, galimų bet kuriai užklausai.
Užklausų dažnio limitai
Atsakuose yra antraštės RateLimit ir RateLimit-Policy bei ankstesnės X-RateLimit-Limit, X-RateLimit-Remaining ir X-RateLimit-Reset. Atsake 429 yra antraštė Retry-After sekundėmis: palaukite ir pakartokite užklausą.