Přejít na obsah
Sursa Developers

GET/v1/folders

Získat stromy složek všech kolekcí

folder_trees

Vrací v jedné odpovědi stromy složek všech kolekcí, ve kterých uživatel vidí alespoň jeden objekt, se stejnými pravidly viditelnosti jako GET /v1/collections/{name}/folders a v pořadí GET /v1/collections. Kolekce bez viditelných objektů se vynechá. Kromě cards má každá složka součty podstromu cards_total, sensitive_total a top_category. S updated_since nebo metadata[<key>]= obsahují folders každé kolekce odpovídající složky jako plochý seznam (children je prázdné a parent_id udává místo ve stromu). S updated_since jsou seřazeny podle updated_at vzestupně, poté podle id; bez něj v pořadí sort_key. Kolekce bez odpovídajících složek se vynechají.

Autentizace

Odešlete klíč API v hlavičce Authorization: Authorization: Bearer <klíč>.

Parametry dotazu

  • limitinteger

    Velikost stránky. Bez limit a cursor se vrací celý seznam; s ním nejvýše limit položek a další stránka je uvedena v hlavičkách Link (rel="next") a X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Kurzor další stránky z X-Next-Cursor nebo z next_cursor předchozí odpovědi se stejnými filtry; nese i velikost stránky. Společně s offset: 422 validation.failed; kurzor jiného seznamu, jiných filtrů nebo poškozený kurzor: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Jen objekty s updated_at v tento okamžik nebo později (RFC 3339 s časovým posunem), pro synchronizaci. S tímto parametrem je seznam seřazen podle updated_at vzestupně, poté podle id, a kurzor pokračuje v tomto pořadí. Smazané objekty se nevypisují: smazání přicházejí jako události.

    length ≤ 512

  • metadatamap of string

    Filtr podle metadata: metadata[<key>]=<value> vyhovuje při přesné shodě. Nejvýše 3 podmínky a všechny musí platit (?metadata[team]=support&metadata[crm_id]=A-1042). Více než 3 podmínky nebo neplatný klíč vrací 400 api.metadata_invalid.

Odpovědi

200Úspěšná odpověď

Hlavičky odpovědi

  • Link

    Adresa další stránky, <…>; rel="next". Chybí-li hlavička, jde o poslední stránku.

  • X-Next-Cursor

    Kurzor další stránky pro parametr cursor. Chybí-li hlavička, jde o poslední stránku.

  • RateLimit-Policy

    Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.

  • RateLimit

    Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).

  • X-RateLimit-Remaining

    Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.

  • X-RateLimit-Reset

    Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: FolderTreeList

array of FolderTree
  • collection_idintegerpovinné
  • collection_namestringpovinné
  • collection_titlestringpovinné

    Název kolekce pro zobrazení.

  • permissionsarray of stringpovinné

    Účinná oprávnění uživatele ke kolekci.

  • unfiledintegerpovinné

    Karty kolekce dostupné uživateli, které nejsou v žádné složce. Archivované karty se nezapočítávají, stejně jako ve výchozím seznamu karet.

  • foldersarray of FolderNodepovinné
401Nebyly odeslány žádné přihlašovací údaje (ani cookie relace, ani klíč API), nebo klíč nebyl nalezen.

Hlavičky odpovědi

  • RateLimit-Policy

    Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.

  • RateLimit

    Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).

  • X-RateLimit-Remaining

    Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.

  • X-RateLimit-Reset

    Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

429Příliš mnoho požadavků (`api.rate_limited`), kvóta organizace na minutu, den nebo měsíc je vyčerpána (`api.quota_exceeded`; `error.details` obsahuje `quota`, `limit` a `reset_at`), organizace dosáhla svého limitu nebo je služba odpovědí vytížená (`answers.engine_busy`). Počkejte dobu uvedenou v hlavičce `Retry-After`.

Hlavičky odpovědi

  • Retry-After

    Počet sekund, které je třeba počkat před opakováním požadavku.

  • RateLimit-Policy

    Platné limity ve formátu návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddělené čárkou "<name>";q=<quota>;w=<window in seconds>. key je četnost požadavků klíče API (kvóta je nárazová špička, okno je doba jejího úplného obnovení; pro relaci je to user, bez přihlašovacích údajů ip); minute, day a month jsou kvóty organizace na kalendářní minutu, den a měsíc v UTC.

  • RateLimit

    Kolik zbývá z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit nejpřísnější položky v RateLimit-Policy (té, ve které zbývá nejméně požadavků).

  • X-RateLimit-Remaining

    Počet požadavků, které zbývají v rámci nejpřísnějšího limitu.

  • X-RateLimit-Reset

    Počet sekund do obnovení nejpřísnějšího limitu.

application/json

Objekt: Error

Chybové kódy

Kódy, které tato operace může vrátit v error.code, kromě obecných kódů každého požadavku.

Limity četnosti

Odpovědi obsahují hlavičky RateLimit a RateLimit-Policy a starší X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Odpověď 429 má hlavičku Retry-After v sekundách: počkejte a požadavek zopakujte.

← folders · Reference API