GET/v1/folders
Получаване на дърветата с папки на всички колекции
folder_trees
Връща в един отговор дърветата с папки на всички колекции, в които потребителят вижда поне един обект, със същите правила за видимост като GET /v1/collections/{name}/folders и в реда на GET /v1/collections. Колекция без видими обекти се пропуска. Освен cards всяка папка съдържа сборовете за поддървото cards_total, sensitive_total и top_category. С updated_since или metadata[<key>]= полето folders на всяка колекция съдържа съвпадащите папки като плосък списък (children е празен, а parent_id дава мястото в дървото). С updated_since те са подредени по updated_at във възходящ ред, после по id; без него – в реда на sort_key. Колекциите без съвпадащи папки се пропускат.
Удостоверяване
Изпратете API ключ в заглавката Authorization: Authorization: Bearer <ключ>.
Параметри на заявката (query)
limitintegerРазмер на страницата. Без
limitиcursorсе връща целият списък; с него – най-многоlimitелемента, а следващата страница се посочва в заглавкитеLink(rel="next") иX-Next-Cursor.≥ 1, ≤ 200
cursorstringКурсор на следващата страница от
X-Next-Cursorилиnext_cursorна предишния отговор със същите филтри; той носи и размера на страницата. Заедно сoffset:422 validation.failed; курсор от друг списък, с други филтри или повреден курсор:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Само обекти с
updated_atв този момент или след него (RFC 3339 с отместване), за синхронизация. С него списъкът е подреден поupdated_atвъв възходящ ред, после поid, и курсорът продължава в същия ред. Изтритите обекти не се изброяват: изтриванията идват като събития.length ≤ 512
metadatamap of stringФилтър по
metadata:metadata[<key>]=<value>търси точно съвпадение. До 3 условия, като всички трябва да съвпадат (?metadata[team]=support&metadata[crm_id]=A-1042). Повече от 3 условия или невалиден ключ връща400 api.metadata_invalid.
Отговори
200Успешен отговор
Заглавки на отговора
LinkАдрес на следващата страница,
<…>; rel="next". Липсата на заглавката означава, че това е последната страница.X-Next-CursorКурсор на следващата страница за параметъра
cursor. Липсата на заглавката означава, че това е последната страница.RateLimit-PolicyДействащите лимити във формата на черновата на IETF
draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи"<name>";q=<quota>;w=<window in seconds>.keyе честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия еuser, без идентификационни данни –ip);minute,dayиmonthса квотите на организацията за календарната минута, ден и месец по UTC.RateLimitКакво остава от всеки лимит в
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitЛимитът на най-строгия запис в
RateLimit-Policy(този с най-малко оставащи заявки).X-RateLimit-RemainingОставащи заявки по най-строгия лимит.
X-RateLimit-ResetСекунди до нулирането на най-строгия лимит.
application/json
collection_idintegerзадължителноcollection_namestringзадължителноcollection_titlestringзадължителноИме на колекцията за показване.
permissionsarray of stringзадължителноДействителните права на потребителя върху колекцията.
unfiledintegerзадължителноДостъпни за потребителя карти на колекцията, които не са в никоя папка. Архивираните карти не се броят, както в списъка с карти по подразбиране.
401Не са изпратени идентификационни данни (нито бисквитка на сесията, нито API ключ) или ключът не е намерен.
Заглавки на отговора
RateLimit-PolicyДействащите лимити във формата на черновата на IETF
draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи"<name>";q=<quota>;w=<window in seconds>.keyе честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия еuser, без идентификационни данни –ip);minute,dayиmonthса квотите на организацията за календарната минута, ден и месец по UTC.RateLimitКакво остава от всеки лимит в
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitЛимитът на най-строгия запис в
RateLimit-Policy(този с най-малко оставащи заявки).X-RateLimit-RemainingОставащи заявки по най-строгия лимит.
X-RateLimit-ResetСекунди до нулирането на най-строгия лимит.
application/json
429Твърде много заявки (`api.rate_limited`), квотата на организацията за минутата, деня или месеца е изчерпана (`api.quota_exceeded`; `error.details` съдържа `quota`, `limit` и `reset_at`), достигнат е лимит на организацията или услугата за отговори е заета (`answers.engine_busy`). Изчакайте времето от заглавката `Retry-After`.
Заглавки на отговора
Retry-AfterБрой секунди, които да изчакате, преди да повторите заявката.
RateLimit-PolicyДействащите лимити във формата на черновата на IETF
draft-ietf-httpapi-ratelimit-headers: разделени със запетая елементи"<name>";q=<quota>;w=<window in seconds>.keyе честотата на заявките на API ключа (квотата е пиковото натоварване, прозорецът е времето за пълното ѝ възстановяване; за сесия еuser, без идентификационни данни –ip);minute,dayиmonthса квотите на организацията за календарната минута, ден и месец по UTC.RateLimitКакво остава от всеки лимит в
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitЛимитът на най-строгия запис в
RateLimit-Policy(този с най-малко оставащи заявки).X-RateLimit-RemainingОставащи заявки по най-строгия лимит.
X-RateLimit-ResetСекунди до нулирането на най-строгия лимит.
application/json
Кодове на грешки
Кодове, които тази операция може да върне в error.code, освен общите кодове на всяка заявка.
Лимити на честотата
Отговорите съдържат заглавките RateLimit и RateLimit-Policy, както и по-ранните X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset. Отговорът 429 съдържа Retry-After в секунди: изчакайте и опитайте отново.