GET/v1/folders
Hae kaikkien kokoelmien kansiopuut
folder_trees
Palauttaa yhdessä vastauksessa kaikkien niiden kokoelmien kansiopuut, joissa käyttäjä näkee vähintään yhden objektin, samoilla näkyvyyssäännöillä kuin GET /v1/collections/{name}/folders ja samassa järjestyksessä kuin GET /v1/collections. Kokoelma, jossa ei ole näkyviä objekteja, jätetään pois. cards-kentän lisäksi jokaisessa kansiossa on alipuun summat cards_total, sensitive_total ja top_category. Kun mukana on updated_since tai metadata[<key>]=, kunkin kokoelman folders sisältää vastaavat kansiot tasaisena listana (children on tyhjä, ja parent_id kertoo paikan puussa). updated_since-parametrin kanssa ne lajitellaan updated_at-kentän mukaan nousevasti ja sitten id-kentän mukaan; ilman sitä sort_key-järjestyksessä. Kokoelmat, joissa ei ole vastaavia kansioita, jätetään pois.
Todennus
Lähetä API-avain Authorization-otsakkeessa: Authorization: Bearer <avain>.
Kyselyparametrit
limitintegerSivukoko. Ilman
limit- jacursor-parametreja palautetaan koko lista; parametrin kanssa enintäänlimitkohdetta, ja seuraavan sivun osoite onLink-otsakkeessa (rel="next") jaX-Next-Cursor-otsakkeessa.≥ 1, ≤ 200
cursorstringSeuraavan sivun kursori
X-Next-Cursor-otsakkeesta tai edellisen, samoilla suodattimilla tehdyn vastauksennext_cursor-kentästä; se sisältää sivukoon. Yhdessäoffset-parametrin kanssa:422 validation.failed; toisen listan kursori, eri suodattimet tai virheellinen kursori:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Vain objektit, joiden
updated_aton tämä hetki tai sen jälkeen (RFC 3339 -muodossa aikavyöhykkeen siirtymän kanssa), synkronointia varten. Sen kanssa lista lajitellaanupdated_at-kentän mukaan nousevasti ja sittenid-kentän mukaan, ja kursori jatkaa samassa järjestyksessä. Poistettuja objekteja ei listata: poistot tulevat tapahtumina.length ≤ 512
metadatamap of stringSuodatus
metadata-kentän mukaan:metadata[<key>]=<value>edellyttää täsmällistä vastaavuutta. Enintään 3 ehtoa, ja jokaisen niistä täytyy täyttyä (?metadata[team]=support&metadata[crm_id]=A-1042). Yli 3 ehtoa tai virheellinen avain palauttaa400 api.metadata_invalid.
Vastaukset
200Onnistunut vastaus
Vastausotsakkeet
LinkSeuraavan sivun osoite,
<…>; rel="next". Jos otsaketta ei ole, tämä on viimeinen sivu.X-Next-CursorSeuraavan sivun kursori
cursor-parametria varten. Jos otsaketta ei ole, tämä on viimeinen sivu.RateLimit-PolicyVoimassa olevat rajat IETF-luonnoksen
draft-ietf-httpapi-ratelimit-headersmuodossa: pilkuin erotetut kohteet"<name>";q=<quota>;w=<window in seconds>.keyon API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se onuser, ilman tunnistetietojaip);minute,dayjamonthovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.RateLimitMitä kustakin
RateLimit-Policy-otsakkeen rajasta on jäljellä:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitRateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).X-RateLimit-RemainingTiukimman rajan puitteissa jäljellä olevat pyynnöt.
X-RateLimit-ResetSekunteja siihen, kun tiukin raja nollautuu.
application/json
collection_idintegerpakollinencollection_namestringpakollinencollection_titlestringpakollinenKokoelman näytettävä nimi.
permissionsarray of stringpakollinenKäyttäjän voimassa olevat käyttöoikeudet kokoelmaan.
unfiledintegerpakollinenKäyttäjän käytettävissä olevat kokoelman kortit, jotka eivät ole missään kansiossa. Arkistoituja kortteja ei lasketa, kuten oletusarvoisessa korttiluettelossa.
401Tunnistetietoja ei lähetetty (ei istuntoevästettä eikä API-avainta), tai avainta ei löytynyt.
Vastausotsakkeet
RateLimit-PolicyVoimassa olevat rajat IETF-luonnoksen
draft-ietf-httpapi-ratelimit-headersmuodossa: pilkuin erotetut kohteet"<name>";q=<quota>;w=<window in seconds>.keyon API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se onuser, ilman tunnistetietojaip);minute,dayjamonthovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.RateLimitMitä kustakin
RateLimit-Policy-otsakkeen rajasta on jäljellä:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitRateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).X-RateLimit-RemainingTiukimman rajan puitteissa jäljellä olevat pyynnöt.
X-RateLimit-ResetSekunteja siihen, kun tiukin raja nollautuu.
application/json
429Liian monta pyyntöä (`api.rate_limited`), organisaation minuutti-, päivä- tai kuukausikiintiö on käytetty (`api.quota_exceeded`; `error.details` sisältää kentät `quota`, `limit` ja `reset_at`), organisaation raja on saavutettu tai vastauspalvelu on kuormitettu (`answers.engine_busy`). Odota `Retry-After`-otsakkeen ilmoittama aika.
Vastausotsakkeet
Retry-AfterKuinka monta sekuntia odotetaan ennen pyynnön uusintayritystä.
RateLimit-PolicyVoimassa olevat rajat IETF-luonnoksen
draft-ietf-httpapi-ratelimit-headersmuodossa: pilkuin erotetut kohteet"<name>";q=<quota>;w=<window in seconds>.keyon API-avaimen pyyntönopeus (kiintiö on purske, aikaikkuna on aika, jossa se täyttyy kokonaan; istunnolle se onuser, ilman tunnistetietojaip);minute,dayjamonthovat organisaation kiintiöt UTC-ajan kalenteriminuutille, -päivälle ja -kuukaudelle.RateLimitMitä kustakin
RateLimit-Policy-otsakkeen rajasta on jäljellä:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitRateLimit-Policy-otsakkeen tiukimman kohteen raja (sen, jossa pyyntöjä on jäljellä vähiten).X-RateLimit-RemainingTiukimman rajan puitteissa jäljellä olevat pyynnöt.
X-RateLimit-ResetSekunteja siihen, kun tiukin raja nollautuu.
application/json
Virhekoodit
Koodit, jotka tämä päätepiste voi palauttaa error.code-kentässä kaikkien pyyntöjen yleisten koodien lisäksi.
Nopeusrajoitukset
Vastauksissa ovat RateLimit- ja RateLimit-Policy-otsakkeet sekä aiemmat X-RateLimit-Limit, X-RateLimit-Remaining ja X-RateLimit-Reset. 429-vastauksessa on Retry-After sekunteina: odota ja yritä uudelleen.