GET/v1/folders
Hent mappetrærne til alle samlinger
folder_trees
Returnerer i ett svar mappetrærne til alle samlinger der brukeren kan se minst ett objekt, med de samme synlighetsreglene som GET /v1/collections/{name}/folders og i rekkefølgen fra GET /v1/collections. En samling uten synlige objekter utelates. I tillegg til cards har hver mappe summene for undertreet cards_total, sensitive_total og top_category. Med updated_since eller metadata[<key>]= inneholder folders for hver samling mappene som oppfyller filteret, som en flat liste (children er tom, og parent_id angir plassen i treet). Med updated_since sorteres de etter updated_at stigende, deretter etter id; uten den i sort_key-rekkefølge. Samlinger uten mapper som oppfyller filteret, utelates.
Autentisering
Send en API-nøkkel i headeren Authorization: Authorization: Bearer <nøkkel>.
Spørringsparametere
limitintegerSidestørrelse. Uten
limitogcursorreturneres hele listen; med den høystlimitelementer, og neste side oppgis i headerneLink(rel="next") ogX-Next-Cursor.≥ 1, ≤ 200
cursorstringCursor for neste side fra
X-Next-Cursorellernext_cursori forrige svar med de samme filtrene; den inneholder sidestørrelsen. Sammen medoffset:422 validation.failed; en cursor fra en annen liste, med andre filtre eller i feil format:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Bare objekter med
updated_atpå eller etter dette tidspunktet (RFC 3339 med tidssoneforskyvning), for synkronisering. Med denne parameteren sorteres listen etterupdated_atstigende, deretter etterid, og cursoren fortsetter i den rekkefølgen. Slettede objekter vises ikke i listen: slettinger kommer som hendelser.length ≤ 512
metadatamap of stringFilter på
metadata:metadata[<key>]=<value>gir eksakt treff. Opptil 3 betingelser, og alle må være oppfylt (?metadata[team]=support&metadata[crm_id]=A-1042). Flere enn 3 betingelser eller en ugyldig nøkkel returnerer400 api.metadata_invalid.
Svar
200Vellykket svar
Headere i svaret
LinkAdressen til neste side,
<…>; rel="next". Ingen header betyr at dette er siste side.X-Next-CursorCursor for neste side til parameteren
cursor. Ingen header betyr at dette er siste side.RateLimit-PolicyGjeldende grenser i formatet fra IETF-utkastet
draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer"<name>";q=<quota>;w=<window in seconds>.keyer forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er detuser, uten påloggingsinformasjonip);minute,dayogmonther organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.RateLimitHva som gjenstår av hver grense i
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGrensen for den strengeste oppføringen i
RateLimit-Policy(den med færrest gjenværende forespørsler).X-RateLimit-RemainingGjenværende forespørsler under den strengeste grensen.
X-RateLimit-ResetSekunder til den strengeste grensen nullstilles.
application/json
collection_idintegerobligatoriskcollection_namestringobligatoriskcollection_titlestringobligatoriskSamlingens navn til visning.
permissionsarray of stringobligatoriskBrukerens faktiske tillatelser på samlingen.
unfiledintegerobligatoriskKort i samlingen som er tilgjengelige for brukeren og ikke ligger i noen mappe. Arkiverte kort telles ikke med, som i standardvisningen av kortlisten.
401Ingen påloggingsinformasjon ble sendt (verken øktinformasjonskapsel eller API-nøkkel), eller nøkkelen ble ikke funnet.
Headere i svaret
RateLimit-PolicyGjeldende grenser i formatet fra IETF-utkastet
draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer"<name>";q=<quota>;w=<window in seconds>.keyer forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er detuser, uten påloggingsinformasjonip);minute,dayogmonther organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.RateLimitHva som gjenstår av hver grense i
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGrensen for den strengeste oppføringen i
RateLimit-Policy(den med færrest gjenværende forespørsler).X-RateLimit-RemainingGjenværende forespørsler under den strengeste grensen.
X-RateLimit-ResetSekunder til den strengeste grensen nullstilles.
application/json
429For mange forespørsler (`api.rate_limited`), organisasjonens kvote for minuttet, døgnet eller måneden er brukt opp (`api.quota_exceeded`; `error.details` inneholder `quota`, `limit` og `reset_at`), organisasjonens grense er nådd, eller svartjenesten er opptatt (`answers.engine_busy`). Vent så lenge som headeren `Retry-After` angir.
Headere i svaret
Retry-AfterAntall sekunder du skal vente før du prøver forespørselen på nytt.
RateLimit-PolicyGjeldende grenser i formatet fra IETF-utkastet
draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer"<name>";q=<quota>;w=<window in seconds>.keyer forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er detuser, uten påloggingsinformasjonip);minute,dayogmonther organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.RateLimitHva som gjenstår av hver grense i
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitGrensen for den strengeste oppføringen i
RateLimit-Policy(den med færrest gjenværende forespørsler).X-RateLimit-RemainingGjenværende forespørsler under den strengeste grensen.
X-RateLimit-ResetSekunder til den strengeste grensen nullstilles.
application/json
Feilkoder
Kodene denne operasjonen kan returnere i error.code, i tillegg til de generelle kodene for alle forespørsler.
Hastighetsgrenser
Svarene har headerne RateLimit og RateLimit-Policy og de eldre X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Et 429-svar har Retry-After i sekunder: Vent, og prøv på nytt.