GET/v1/folders
Az összes gyűjtemény mappafájának lekérése
folder_trees
Egyetlen válaszban adja vissza mindazoknak a gyűjteményeknek a mappafáit, amelyekben a felhasználó legalább egy objektumot lát, ugyanazokkal a láthatósági szabályokkal, mint a GET /v1/collections/{name}/folders, és a GET /v1/collections sorrendjében. A látható objektum nélküli gyűjtemény kimarad. A cards mellett minden mappánál szerepelnek a részfa összesítői is: cards_total, sensitive_total és top_category. Az updated_since vagy a metadata[<key>]= paraméterrel minden gyűjtemény folders mezője lapos listaként tartalmazza az egyező mappákat (a children üres, a parent_id pedig megadja a helyüket a fában). Az updated_since paraméterrel updated_at szerint növekvő sorrendben, azon belül id szerint rendeződnek; nélküle sort_key szerinti sorrendben. Az egyező mappa nélküli gyűjtemények kimaradnak.
Hitelesítés
Küldj egy API-kulcsot az Authorization fejlécben: Authorization: Bearer <kulcs>.
Lekérdezési paraméterek
limitintegerOldalméret.
limitéscursornélkül a teljes listát adja vissza; a paraméterrel legfeljebblimitelemet, a következő oldalt pedig aLink(rel="next") és azX-Next-Cursorfejléc adja meg.≥ 1, ≤ 200
cursorstringA következő oldal kurzora az előző, azonos szűrőkkel küldött kérésre kapott válasz
X-Next-Cursorfejlécéből vagynext_cursormezőjéből; az oldalméretet is magában hordozza. Azoffsetparaméterrel együtt:422 validation.failed; más lista vagy más szűrők kurzora, illetve hibás kurzor:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Csak azok az objektumok, amelyek
updated_atértéke erre az időpontra vagy későbbre esik (RFC 3339, időeltolással), szinkronizáláshoz. Ezzel a paraméterrel a listaupdated_atszerint növekvő sorrendű, azon belülidszerint, és a kurzor ebben a sorrendben halad tovább. A törölt objektumok nem szerepelnek a listában: a törlések eseményként érkeznek.length ≤ 512
metadatamap of stringSzűrés
metadataszerint: ametadata[<key>]=<value>pontos egyezést jelent. Legfeljebb 3 feltétel adható meg, és mindegyiknek teljesülnie kell (?metadata[team]=support&metadata[crm_id]=A-1042). 3-nál több feltétel vagy érvénytelen kulcs esetén a válasz400 api.metadata_invalid.
Válaszok
200Sikeres válasz
Válaszfejlécek
LinkA következő oldal címe,
<…>; rel="next". Ha a fejléc hiányzik, ez az utolsó oldal.X-Next-CursorA következő oldal kurzora a
cursorparaméterhez. Ha a fejléc hiányzik, ez az utolsó oldal.RateLimit-PolicyAz érvényben lévő korlátok az IETF
draft-ietf-httpapi-ratelimit-headerstervezetének formátumában: vesszővel elválasztott"<name>";q=<quota>;w=<window in seconds>elemek. Akeyaz API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnéluser, hitelesítő adatok nélkülip); aminute, adayés amontha szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.RateLimitMennyi maradt a
RateLimit-Policyegyes korlátaiból:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitA
RateLimit-Policylegszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).X-RateLimit-RemainingA legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-ResetA legszigorúbb korlát visszaállásáig hátralévő másodpercek.
application/json
collection_idintegerkötelezőcollection_namestringkötelezőcollection_titlestringkötelezőA gyűjtemény megjelenítendő neve.
permissionsarray of stringkötelezőA felhasználó tényleges jogosultságai a gyűjteményen.
unfiledintegerkötelezőA gyűjtemény felhasználó számára elérhető kártyái, amelyek egyik mappában sincsenek. Az archivált kártyák nem számítanak bele, mint az alapértelmezett kártyalistában.
401Nem érkeztek hitelesítő adatok (sem munkamenet-süti, sem API-kulcs), vagy a kulcs nem található.
Válaszfejlécek
RateLimit-PolicyAz érvényben lévő korlátok az IETF
draft-ietf-httpapi-ratelimit-headerstervezetének formátumában: vesszővel elválasztott"<name>";q=<quota>;w=<window in seconds>elemek. Akeyaz API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnéluser, hitelesítő adatok nélkülip); aminute, adayés amontha szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.RateLimitMennyi maradt a
RateLimit-Policyegyes korlátaiból:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitA
RateLimit-Policylegszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).X-RateLimit-RemainingA legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-ResetA legszigorúbb korlát visszaállásáig hátralévő másodpercek.
application/json
429Túl sok kérés (`api.rate_limited`), elfogyott a szervezet percre, napra vagy hónapra szóló kvótája (`api.quota_exceeded`; az `error.details` a `quota`, a `limit` és a `reset_at` mezőt tartalmazza), a szervezet elérte a korlátját, vagy a válaszszolgáltatás foglalt (`answers.engine_busy`). Várj a `Retry-After` fejlécben megadott ideig.
Válaszfejlécek
Retry-AfterEnnyi másodpercet várj, mielőtt újrapróbálod a kérést.
RateLimit-PolicyAz érvényben lévő korlátok az IETF
draft-ietf-httpapi-ratelimit-headerstervezetének formátumában: vesszővel elválasztott"<name>";q=<quota>;w=<window in seconds>elemek. Akeyaz API-kulcs kérésgyakorisága (a kvóta a csúcskeret, az időablak a teljes visszatöltődés ideje; munkamenetnéluser, hitelesítő adatok nélkülip); aminute, adayés amontha szervezetnek az UTC szerinti naptári percre, napra és hónapra szóló kvótája.RateLimitMennyi maradt a
RateLimit-Policyegyes korlátaiból:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitA
RateLimit-Policylegszigorúbb elemének korlátja (amelyből a legkevesebb kérés maradt).X-RateLimit-RemainingA legszigorúbb korlát szerint még hátralévő kérések száma.
X-RateLimit-ResetA legszigorúbb korlát visszaállásáig hátralévő másodpercek.
application/json
Hibakódok
Azok a kódok, amelyeket ez a végpont hiba esetén az error.code mezőben visszaadhat, a minden kérésre érvényes általános kódokon kívül.
Gyakorisági korlátok
A válaszokban ott van a RateLimit és a RateLimit-Policy fejléc, valamint a korábbi X-RateLimit-Limit, X-RateLimit-Remaining és X-RateLimit-Reset fejléc. A 429-es válasz Retry-After fejléce másodpercben adja meg a várakozást: várj, majd próbáld újra.