GET/v1/folders
Mappenbomen van alle collecties ophalen
folder_trees
Geeft in één response de mappenbomen terug van alle collecties waarin de gebruiker minstens één object kan zien, met dezelfde zichtbaarheidsregels als GET /v1/collections/{name}/folders en in de volgorde van GET /v1/collections. Een collectie zonder zichtbare objecten wordt weggelaten. Naast cards heeft elke map de totalen van de subboom cards_total, sensitive_total en top_category. Met updated_since of metadata[<key>]= bevatten de folders van elke collectie de overeenkomende mappen als platte lijst (children is leeg, en parent_id geeft de plaats in de boom). Met updated_since worden ze oplopend gesorteerd op updated_at en daarna op id; zonder die parameter in de volgorde van sort_key. Collecties zonder overeenkomende mappen worden weggelaten.
Authenticatie
Stuur een API-sleutel mee in de header Authorization: Authorization: Bearer <sleutel>.
Queryparameters
limitintegerPaginagrootte. Zonder
limitencursorwordt de hele lijst teruggegeven; met deze parameter maximaallimititems, en de volgende pagina staat in de headersLink(rel="next") enX-Next-Cursor.≥ 1, ≤ 200
cursorstringCursor van de volgende pagina uit
X-Next-Cursorofnext_cursorvan de vorige response met dezelfde filters; de cursor bevat de paginagrootte. Samen metoffset:422 validation.failed; een cursor van een andere lijst, met andere filters of een misvormde cursor:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Alleen objecten met
updated_atop of na dit tijdstip (RFC 3339 met een tijdzoneverschuiving), voor synchronisatie. Hiermee wordt de lijst oplopend gesorteerd opupdated_aten daarna opid, en gaat de cursor in die volgorde verder. Verwijderde objecten staan niet in de lijst: verwijderingen komen binnen als events.length ≤ 512
metadatamap of stringFilter op
metadata:metadata[<key>]=<value>moet exact overeenkomen. Maximaal 3 voorwaarden, en ze moeten allemaal kloppen (?metadata[team]=support&metadata[crm_id]=A-1042). Meer dan 3 voorwaarden of een ongeldige sleutel geeft400 api.metadata_invalid.
Responses
200Geslaagde response
Responseheaders
LinkAdres van de volgende pagina,
<…>; rel="next". Zonder deze header is dit de laatste pagina.X-Next-CursorCursor van de volgende pagina voor de parameter
cursor. Zonder deze header is dit de laatste pagina.RateLimit-PolicyGeldende limieten, in het formaat van het IETF-concept
draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s,"<name>";q=<quota>;w=<window in seconds>.keyis de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is hetuser, zonder authenticatiegegevensip);minute,dayenmonthzijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.RateLimitWat er over is van elke limiet in
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimiet van de strengste regel in
RateLimit-Policy(die met de minste resterende requests).X-RateLimit-RemainingResterende requests onder de strengste limiet.
X-RateLimit-ResetSeconden tot de strengste limiet wordt teruggezet.
application/json
collection_idintegerverplichtcollection_namestringverplichtcollection_titlestringverplichtNaam van de collectie voor weergave.
permissionsarray of stringverplichtDe effectieve rechten van de gebruiker op de collectie.
unfiledintegerverplichtKaarten van de collectie die beschikbaar zijn voor de gebruiker en in geen enkele map staan. Gearchiveerde kaarten tellen niet mee, zoals in de standaardlijst van kaarten.
401Er zijn geen authenticatiegegevens meegestuurd (geen sessiecookie en geen API-sleutel), of de sleutel is niet gevonden.
Responseheaders
RateLimit-PolicyGeldende limieten, in het formaat van het IETF-concept
draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s,"<name>";q=<quota>;w=<window in seconds>.keyis de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is hetuser, zonder authenticatiegegevensip);minute,dayenmonthzijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.RateLimitWat er over is van elke limiet in
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimiet van de strengste regel in
RateLimit-Policy(die met de minste resterende requests).X-RateLimit-RemainingResterende requests onder de strengste limiet.
X-RateLimit-ResetSeconden tot de strengste limiet wordt teruggezet.
application/json
429Te veel requests (`api.rate_limited`), het quotum van de organisatie voor de minuut, dag of maand is op (`api.quota_exceeded`; `error.details` bevat `quota`, `limit` en `reset_at`), de limiet van de organisatie is bereikt, of de antwoorddienst is bezet (`answers.engine_busy`). Wacht de tijd af die in de header `Retry-After` staat.
Responseheaders
Retry-AfterAantal seconden dat je moet wachten voordat je het request opnieuw probeert.
RateLimit-PolicyGeldende limieten, in het formaat van het IETF-concept
draft-ietf-httpapi-ratelimit-headers: items gescheiden door komma’s,"<name>";q=<quota>;w=<window in seconds>.keyis de requestsnelheid van de API-sleutel (het quotum is de piek, het venster de tijd om die volledig aan te vullen; voor een sessie is hetuser, zonder authenticatiegegevensip);minute,dayenmonthzijn de quota van de organisatie voor de kalenderminuut, -dag en -maand in UTC.RateLimitWat er over is van elke limiet in
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimiet van de strengste regel in
RateLimit-Policy(die met de minste resterende requests).X-RateLimit-RemainingResterende requests onder de strengste limiet.
X-RateLimit-ResetSeconden tot de strengste limiet wordt teruggezet.
application/json
Foutcodes
Codes die dit endpoint in error.code kan teruggeven, naast de algemene codes van elk request.
Snelheidslimieten
Responses bevatten de headers RateLimit en RateLimit-Policy en de eerdere X-RateLimit-Limit, X-RateLimit-Remaining en X-RateLimit-Reset. Een response met status 429 bevat Retry-After in seconden: wacht en probeer het daarna opnieuw.