GET/v1/folders
Tüm koleksiyonların klasör ağaçlarını getirme
folder_trees
Kullanıcının en az bir nesneyi görebildiği tüm koleksiyonların klasör ağaçlarını tek bir yanıtta, GET /v1/collections/{name}/folders ile aynı görünürlük kurallarıyla ve GET /v1/collections sırasıyla döndürür. Görünür nesnesi olmayan koleksiyon dahil edilmez. Her klasörde cards alanının yanı sıra cards_total, sensitive_total ve top_category alt ağaç toplamları bulunur. updated_since ya da metadata[<key>]= ile her koleksiyonun folders alanı eşleşen klasörleri düz bir liste olarak içerir (children boştur, ağaçtaki yeri parent_id gösterir). updated_since ile klasörler önce artan updated_at değerine, sonra id değerine göre sıralanır; onsuz sort_key sırasındadır. Eşleşen klasörü olmayan koleksiyonlar dahil edilmez.
Kimlik doğrulama
API anahtarını Authorization başlığında gönderin: Authorization: Bearer <anahtar>.
Sorgu parametreleri
limitintegerSayfa boyutu.
limitvecursorolmadan listenin tamamı döndürülür; bu parametreyle en fazlalimitöğe döner ve sonraki sayfaLink(rel="next") veX-Next-Cursorbaşlıklarında verilir.≥ 1, ≤ 200
cursorstringSonraki sayfanın imleci: aynı filtrelerle alınan önceki yanıtın
X-Next-Cursorbaşlığından ya danext_cursoralanından alınır; sayfa boyutunu da taşır.offsetile birlikte:422 validation.failed; başka bir listeye ya da başka filtrelere ait veya bozuk bir imleç:400 api.cursor_invalid.length ≤ 512
updated_sincestring (date-time)Senkronizasyon için yalnızca
updated_atdeğeri bu anda ya da bu andan sonra olan nesneler (UTC farkı içeren RFC 3339). Bu parametreyle liste önce artanupdated_atdeğerine, sonraiddeğerine göre sıralanır ve imleç bu sırayla devam eder. Silinen nesneler listelenmez: silinenler olay olarak gelir.length ≤ 512
metadatamap of stringmetadataalanına göre filtre:metadata[<key>]=<value>tam eşleşme arar. En fazla 3 koşul verilebilir ve hepsi eşleşmelidir (?metadata[team]=support&metadata[crm_id]=A-1042). 3’ten fazla koşul ya da geçersiz bir anahtar400 api.metadata_invaliddöndürür.
Yanıtlar
200Başarılı yanıt
Yanıt başlıkları
LinkSonraki sayfanın adresi,
<…>; rel="next". Başlık yoksa bu son sayfadır.X-Next-Cursorcursorparametresi için sonraki sayfanın imleci. Başlık yoksa bu son sayfadır.RateLimit-PolicyGeçerli limitler, IETF taslağı
draft-ietf-httpapi-ratelimit-headersbiçiminde: virgülle ayrılmış"<name>";q=<quota>;w=<window in seconds>öğeleri.key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum içinuser, kimlik bilgisi olmadanip);minute,dayvemonth, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.RateLimitRateLimit-Policyiçindeki her limitten kalan:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitRateLimit-Policyiçindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).X-RateLimit-RemainingEn sıkı limitte kalan istek sayısı.
X-RateLimit-ResetEn sıkı limitin sıfırlanmasına kalan saniye.
application/json
collection_idintegerzorunlucollection_namestringzorunlucollection_titlestringzorunluGörüntülenecek koleksiyon adı.
permissionsarray of stringzorunluKullanıcının koleksiyondaki etkin izinleri.
unfiledintegerzorunluKoleksiyonun, kullanıcının erişebildiği ve hiçbir klasörde olmayan kartları. Varsayılan kart listesinde olduğu gibi arşivlenmiş kartlar sayılmaz.
401Kimlik bilgisi gönderilmedi (ne oturum çerezi ne de API anahtarı) ya da anahtar bulunamadı.
Yanıt başlıkları
RateLimit-PolicyGeçerli limitler, IETF taslağı
draft-ietf-httpapi-ratelimit-headersbiçiminde: virgülle ayrılmış"<name>";q=<quota>;w=<window in seconds>öğeleri.key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum içinuser, kimlik bilgisi olmadanip);minute,dayvemonth, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.RateLimitRateLimit-Policyiçindeki her limitten kalan:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitRateLimit-Policyiçindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).X-RateLimit-RemainingEn sıkı limitte kalan istek sayısı.
X-RateLimit-ResetEn sıkı limitin sıfırlanmasına kalan saniye.
application/json
429Çok fazla istek (`api.rate_limited`), kuruluşun dakika, gün ya da ay kotası doldu (`api.quota_exceeded`; `error.details` alanında `quota`, `limit` ve `reset_at` bulunur), kuruluşun limitine ulaşıldı ya da yanıt hizmeti meşgul (`answers.engine_busy`). `Retry-After` başlığındaki süre kadar bekleyin.
Yanıt başlıkları
Retry-Afterİsteği yeniden denemeden önce beklenmesi gereken saniye sayısı.
RateLimit-PolicyGeçerli limitler, IETF taslağı
draft-ietf-httpapi-ratelimit-headersbiçiminde: virgülle ayrılmış"<name>";q=<quota>;w=<window in seconds>öğeleri.key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum içinuser, kimlik bilgisi olmadanip);minute,dayvemonth, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.RateLimitRateLimit-Policyiçindeki her limitten kalan:"<name>";r=<remaining>;t=<seconds until reset>.X-RateLimit-LimitRateLimit-Policyiçindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).X-RateLimit-RemainingEn sıkı limitte kalan istek sayısı.
X-RateLimit-ResetEn sıkı limitin sıfırlanmasına kalan saniye.
application/json
Hata kodları
Bu uç noktanın, her isteğin genel kodlarının yanı sıra error.code alanında döndürebileceği kodlar.
Hız sınırları
Yanıtlarda RateLimit ve RateLimit-Policy başlıklarıyla birlikte daha eski X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset başlıkları bulunur. 429 yanıtında saniye cinsinden Retry-After başlığı vardır: bekleyin ve yeniden deneyin.