Pāriet uz saturu
Sursa Developers

GET/v1/folders

Iegūt visu kolekciju mapju kokus

folder_trees

Vienā atbildē atgriež visu to kolekciju mapju kokus, kurās lietotājs redz vismaz vienu objektu, ar tiem pašiem redzamības noteikumiem kā GET /v1/collections/{name}/folders un GET /v1/collections secībā. Kolekcija bez redzamiem objektiem netiek iekļauta. Papildus cards katrai mapei ir apakškoka kopsummas cards_total, sensitive_total un top_category. Ar updated_since vai metadata[<key>]= katras kolekcijas laukā folders ir atbilstošās mapes kā vienkāršs saraksts (children ir tukšs, bet parent_id norāda vietu kokā). Ar updated_since tās ir kārtotas pēc updated_at augošā secībā, pēc tam pēc id; bez tā – sort_key secībā. Kolekcijas bez atbilstošām mapēm netiek iekļautas.

Autentifikācija

Nosūtiet API atslēgu galvenē Authorization: Authorization: Bearer <atslēga>.

Vaicājuma parametri

  • limitinteger

    Lapas izmērs. Bez limit un cursor tiek atgriezts viss saraksts; ar to – ne vairāk kā limit elementu, un nākamā lapa ir norādīta galvenēs Link (rel="next") un X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Nākamās lapas kursors no X-Next-Cursor vai next_cursor iepriekšējā atbildē ar tiem pašiem filtriem; tas ietver lapas izmēru. Kopā ar offset – 422 validation.failed; cita saraksta kursors, kursors ar citiem filtriem vai bojāts kursors – 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Tikai objekti, kuru updated_at ir šis brīdis vai vēlāks (RFC 3339 ar laika joslas nobīdi), sinhronizācijai. Ar to saraksts tiek kārtots pēc updated_at augošā secībā, pēc tam pēc id, un kursors turpina šajā secībā. Dzēstie objekti sarakstā neparādās: par dzēšanu ziņo notikumi.

    length ≤ 512

  • metadatamap of string

    Filtrs pēc metadata: metadata[<key>]=<value> pārbauda precīzu atbilstību. Līdz 3 nosacījumiem, un visiem jāizpildās (?metadata[team]=support&metadata[crm_id]=A-1042). Ja nosacījumu ir vairāk nekā 3 vai atslēga nav derīga, atbilde ir 400 api.metadata_invalid.

Atbildes

200Veiksmīga atbilde

Atbildes galvenes

  • Link

    Nākamās lapas adrese, <…>; rel="next". Ja galvenes nav, šī ir pēdējā lapa.

  • X-Next-Cursor

    Nākamās lapas kursors parametram cursor. Ja galvenes nav, šī ir pēdējā lapa.

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: FolderTreeList

array of FolderTree
  • collection_idintegerobligāts
  • collection_namestringobligāts
  • collection_titlestringobligāts

    Kolekcijas nosaukums attēlošanai.

  • permissionsarray of stringobligāts

    Lietotāja faktiskās atļaujas kolekcijai.

  • unfiledintegerobligāts

    Lietotājam pieejamās kolekcijas kartītes, kas nav nevienā mapē. Arhivētās kartītes netiek skaitītas, tāpat kā noklusējuma kartīšu sarakstā.

  • foldersarray of FolderNodeobligāts
401Nav nosūtīti akreditācijas dati (ne sesijas sīkdatne, ne API atslēga), vai atslēga nav atrasta.

Atbildes galvenes

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

429Pārāk daudz pieprasījumu (`api.rate_limited`), organizācijas minūtes, dienas vai mēneša kvota ir izlietota (`api.quota_exceeded`; `error.details` satur `quota`, `limit` un `reset_at`), sasniegts organizācijas limits vai atbilžu pakalpojums ir aizņemts (`answers.engine_busy`). Pagaidiet galvenē `Retry-After` norādīto laiku.

Atbildes galvenes

  • Retry-After

    Sekunžu skaits, kas jāpagaida, pirms atkārtojat pieprasījumu.

  • RateLimit-Policy

    Spēkā esošie limiti IETF dokumenta projekta draft-ietf-httpapi-ratelimit-headers formātā: ar komatiem atdalīti elementi "<name>";q=<quota>;w=<window in seconds>. key ir API atslēgas pieprasījumu biežums (kvota ir īslaicīgais pīķis, laika logs – laiks, kurā kvota pilnībā atjaunojas; sesijai tas ir user, bez akreditācijas datiem – ip); minute, day un month ir organizācijas kvotas kalendārajai minūtei, dienai un mēnesim pēc UTC.

  • RateLimit

    Cik atlicis no katra RateLimit-Policy limita: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Stingrākā RateLimit-Policy ieraksta limits (tā, kurā atlicis vismazāk pieprasījumu).

  • X-RateLimit-Remaining

    Atlikušo pieprasījumu skaits stingrākā limita ietvaros.

  • X-RateLimit-Reset

    Sekundes līdz stingrākā limita atiestatīšanai.

application/json

Objekts: Error

Kļūdu kodi

Kodi, ko šī operācija var atgriezt laukā error.code papildus vispārīgajiem kodiem, kas iespējami jebkuram pieprasījumam.

Pieprasījumu biežuma limiti

Atbildēs ir galvenes RateLimit un RateLimit-Policy, kā arī agrākās X-RateLimit-Limit, X-RateLimit-Remaining un X-RateLimit-Reset. Atbildē 429 ir galvene Retry-After sekundēs: nogaidiet un atkārtojiet pieprasījumu.

← folders · API rokasgrāmata