GET/v1/folders
Hent mappetræerne for alle samlinger
folder_trees
Returnerer i ét svar mappetræerne for alle samlinger, hvor brugeren kan se mindst ét objekt, med de samme synlighedsregler som GET /v1/collections/{name}/folders og i rækkefølgen fra GET /v1/collections. En samling uden synlige objekter udelades. Ud over cards har hver mappe undertræets totaler cards_total, sensitive_total og top_category. Med updated_since eller metadata[<key>]= indeholder folders for hver samling de matchende mapper som en flad liste (children er tom, og parent_id angiver placeringen i træet). Med updated_since sorteres de stigende efter updated_at og derefter efter id; uden den i rækkefølgen efter sort_key. Samlinger uden matchende mapper udelades.
Autentificering
Send en API-nøgle i headeren Authorization: Authorization: Bearer <nøgle>.
Forespørgselsparametre
limitintegerSidestørrelse. Uden
limitogcursorreturneres hele listen; med den højstlimitelementer, og næste side angives i headerneLink(rel="next") ogX-Next-Cursor.≥ 1, ≤ 200
cursorstringCursor for næste side fra
X-Next-Cursorellernext_cursori det forrige svar med de samme filtre; den indeholder sidestørrelsen. Sammen medoffset:422 validation.failed; en cursor fra en anden liste, med andre filtre eller i et ugyldigt format:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Kun objekter med
updated_atpå eller efter dette tidspunkt (RFC 3339 med tidszoneforskydning), til synkronisering. Med den sorteres listen stigende efterupdated_atog derefter efterid, og cursoren fortsætter i samme rækkefølge. Slettede objekter vises ikke: Sletninger kommer som hændelser.length ≤ 512
metadatamap of stringFilter på
metadata:metadata[<key>]=<value>matcher præcist. Op til 3 betingelser, og alle skal være opfyldt (?metadata[team]=support&metadata[crm_id]=A-1042). Mere end 3 betingelser eller en ugyldig nøgle returnerer400 api.metadata_invalid.
Svar
200Vellykket svar
Svarets headere
LinkAdressen på næste side,
<…>; rel="next". Ingen header betyder, at dette er den sidste side.X-Next-CursorCursor for næste side til parameteren
cursor. Ingen header betyder, at dette er den sidste side.RateLimit-PolicyGældende grænser i formatet fra IETF-udkastet
draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer"<name>";q=<quota>;w=<window in seconds>.keyer API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er detuser, uden legitimationsoplysningerip);minute,dayogmonther organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.RateLimitHvad der er tilbage af hver grænse i
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGrænsen for den strengeste post i
RateLimit-Policy(den med færrest resterende anmodninger).X-RateLimit-RemainingResterende anmodninger under den strengeste grænse.
X-RateLimit-ResetSekunder, til den strengeste grænse nulstilles.
application/json
collection_idintegerpåkrævetcollection_namestringpåkrævetcollection_titlestringpåkrævetSamlingens navn til visning.
permissionsarray of stringpåkrævetBrugerens gældende tilladelser på samlingen.
unfiledintegerpåkrævetSamlingens kort, som brugeren har adgang til, og som ikke ligger i nogen mappe. Arkiverede kort tælles ikke med, som i standardvisningen af kortlisten.
401Der blev ikke sendt legitimationsoplysninger (hverken en sessionscookie eller en API-nøgle), eller nøglen blev ikke fundet.
Svarets headere
RateLimit-PolicyGældende grænser i formatet fra IETF-udkastet
draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer"<name>";q=<quota>;w=<window in seconds>.keyer API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er detuser, uden legitimationsoplysningerip);minute,dayogmonther organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.RateLimitHvad der er tilbage af hver grænse i
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGrænsen for den strengeste post i
RateLimit-Policy(den med færrest resterende anmodninger).X-RateLimit-RemainingResterende anmodninger under den strengeste grænse.
X-RateLimit-ResetSekunder, til den strengeste grænse nulstilles.
application/json
429For mange anmodninger (`api.rate_limited`), organisationens kvote for minuttet, dagen eller måneden er brugt op (`api.quota_exceeded`; `error.details` indeholder `quota`, `limit` og `reset_at`), organisationens grænse er nået, eller svartjenesten er optaget (`answers.engine_busy`). Vent den tid, der står i headeren `Retry-After`.
Svarets headere
Retry-AfterAntal sekunder, du skal vente, før du prøver anmodningen igen.
RateLimit-PolicyGældende grænser i formatet fra IETF-udkastet
draft-ietf-httpapi-ratelimit-headers: kommaseparerede elementer"<name>";q=<quota>;w=<window in seconds>.keyer API-nøglens anmodningshastighed (kvoten er burst, vinduet er tiden til fuld genopfyldning; for en session er detuser, uden legitimationsoplysningerip);minute,dayogmonther organisationens kvoter for kalenderminuttet, kalenderdagen og kalendermåneden i UTC.RateLimitHvad der er tilbage af hver grænse i
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGrænsen for den strengeste post i
RateLimit-Policy(den med færrest resterende anmodninger).X-RateLimit-RemainingResterende anmodninger under den strengeste grænse.
X-RateLimit-ResetSekunder, til den strengeste grænse nulstilles.
application/json
Fejlkoder
Koder, som denne operation kan returnere i error.code, ud over de generelle koder for alle anmodninger.
Hastighedsgrænser
Svarene har headerne RateLimit og RateLimit-Policy samt de tidligere X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Et 429-svar har Retry-After i sekunder: Vent, og forsøg igen.