GET/v1/folders
Pobieranie drzew folderów wszystkich kolekcji
folder_trees
Zwraca w jednej odpowiedzi drzewa folderów wszystkich kolekcji, w których użytkownik widzi co najmniej jeden obiekt, z tymi samymi zasadami widoczności co GET /v1/collections/{name}/folders i w kolejności GET /v1/collections. Kolekcja bez widocznych obiektów jest pomijana. Oprócz cards każdy folder ma sumy dla poddrzewa: cards_total, sensitive_total i top_category. Z updated_since lub metadata[<key>]= pole folders każdej kolekcji zawiera pasujące foldery jako płaską listę (children jest puste, a parent_id wskazuje miejsce w drzewie). Z updated_since są one sortowane rosnąco według updated_at, a następnie według id; bez niego – w kolejności sort_key. Kolekcje bez pasujących folderów są pomijane.
Uwierzytelnianie
Wyślij klucz API w nagłówku Authorization: Authorization: Bearer <klucz>.
Parametry zapytania
limitintegerRozmiar strony. Bez
limiticursorzwracana jest cała lista; z tym parametrem – najwyżejlimitelementów, a następna strona jest podana w nagłówkachLink(rel="next") iX-Next-Cursor.≥ 1, ≤ 200
cursorstringKursor następnej strony z
X-Next-Cursorlubnext_cursorpoprzedniej odpowiedzi z tymi samymi filtrami; zawiera rozmiar strony. Razem zoffset:422 validation.failed; kursor innej listy, innych filtrów lub uszkodzony:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Tylko obiekty z
updated_atw tym momencie lub później (RFC 3339 z przesunięciem strefy czasowej), do synchronizacji. Z tym parametrem lista jest sortowana rosnąco wedługupdated_at, a następnie wedługid, a kursor kontynuuje w tej kolejności. Usunięte obiekty nie są wymieniane: usunięcia przychodzą jako zdarzenia.length ≤ 512
metadatamap of stringFiltr według
metadata:metadata[<key>]=<value>oznacza dokładne dopasowanie. Do 3 warunków, wszystkie muszą być spełnione (?metadata[team]=support&metadata[crm_id]=A-1042). Więcej niż 3 warunki lub nieprawidłowy klucz zwracają400 api.metadata_invalid.
Odpowiedzi
200Pomyślna odpowiedź
Nagłówki odpowiedzi
LinkAdres następnej strony,
<…>; rel="next". Brak nagłówka oznacza, że to ostatnia strona.X-Next-CursorKursor następnej strony dla parametru
cursor. Brak nagłówka oznacza, że to ostatnia strona.RateLimit-PolicyObowiązujące limity w formacie projektu IETF
draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami"<name>";q=<quota>;w=<window in seconds>.keyto częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest touser, bez danych uwierzytelniającychip);minute,dayimonthto przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.RateLimitCo pozostało z każdego limitu w
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit najbardziej restrykcyjnej pozycji w
RateLimit-Policy(tej, w której zostało najmniej żądań).X-RateLimit-RemainingLiczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-ResetLiczba sekund do odnowienia najbardziej restrykcyjnego limitu.
application/json
collection_idintegerwymaganecollection_namestringwymaganecollection_titlestringwymaganeNazwa kolekcji do wyświetlania.
permissionsarray of stringwymaganeEfektywne uprawnienia użytkownika do kolekcji.
unfiledintegerwymaganeDostępne dla użytkownika karty kolekcji, które nie są w żadnym folderze. Zarchiwizowane karty nie są liczone, tak jak na domyślnej liście kart.
401Nie przesłano danych uwierzytelniających (ani pliku cookie sesji, ani klucza API) lub nie znaleziono klucza.
Nagłówki odpowiedzi
RateLimit-PolicyObowiązujące limity w formacie projektu IETF
draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami"<name>";q=<quota>;w=<window in seconds>.keyto częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest touser, bez danych uwierzytelniającychip);minute,dayimonthto przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.RateLimitCo pozostało z każdego limitu w
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit najbardziej restrykcyjnej pozycji w
RateLimit-Policy(tej, w której zostało najmniej żądań).X-RateLimit-RemainingLiczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-ResetLiczba sekund do odnowienia najbardziej restrykcyjnego limitu.
application/json
429Zbyt wiele żądań (`api.rate_limited`), wyczerpano przydział organizacji na minutę, dzień lub miesiąc (`api.quota_exceeded`; `error.details` zawiera `quota`, `limit` i `reset_at`), osiągnięto limit organizacji albo usługa odpowiedzi jest zajęta (`answers.engine_busy`). Odczekaj czas podany w nagłówku `Retry-After`.
Nagłówki odpowiedzi
Retry-AfterLiczba sekund oczekiwania przed ponowieniem żądania.
RateLimit-PolicyObowiązujące limity w formacie projektu IETF
draft-ietf-httpapi-ratelimit-headers: elementy rozdzielone przecinkami"<name>";q=<quota>;w=<window in seconds>.keyto częstotliwość żądań klucza API (przydział to wielkość chwilowego szczytu (burst), okno to czas jego pełnego odnowienia; dla sesji jest touser, bez danych uwierzytelniającychip);minute,dayimonthto przydziały organizacji na minutę, dzień i miesiąc kalendarzowy w UTC.RateLimitCo pozostało z każdego limitu w
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitLimit najbardziej restrykcyjnej pozycji w
RateLimit-Policy(tej, w której zostało najmniej żądań).X-RateLimit-RemainingLiczba żądań pozostałych w ramach najbardziej restrykcyjnego limitu.
X-RateLimit-ResetLiczba sekund do odnowienia najbardziej restrykcyjnego limitu.
application/json
Kody błędów
Kody, które ta operacja może zwrócić w error.code, oprócz ogólnych kodów każdego żądania.
Limity częstotliwości
Odpowiedzi zawierają nagłówki RateLimit i RateLimit-Policy oraz starsze X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odpowiedź 429 ma nagłówek Retry-After w sekundach: odczekaj i ponów żądanie.