Langsung ke konten
Sursa Developers

GET/v1/folders

Dapatkan pohon folder semua koleksi

folder_trees

Mengembalikan, dalam satu respons, pohon folder semua koleksi tempat pengguna dapat melihat setidaknya satu objek, dengan aturan visibilitas yang sama seperti GET /v1/collections/{name}/folders dan dalam urutan GET /v1/collections. Koleksi tanpa objek yang terlihat tidak disertakan. Selain cards, setiap folder memiliki total subpohon cards_total, sensitive_total, dan top_category. Dengan updated_since atau metadata[<key>]=, folders dari setiap koleksi berisi folder yang cocok sebagai daftar datar (children kosong, dan parent_id menunjukkan letaknya di pohon). Dengan updated_since, folder diurutkan menurut updated_at secara menaik, lalu menurut id; tanpa parameter itu, dalam urutan sort_key. Koleksi tanpa folder yang cocok tidak disertakan.

Autentikasi

Kirim kunci API di header Authorization: Authorization: Bearer <kunci>.

Parameter kueri

  • limitinteger

    Ukuran halaman. Tanpa limit dan cursor, seluruh daftar dikembalikan; dengan parameter ini, paling banyak limit item, dan halaman berikutnya diberikan di header Link (rel="next") dan X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Kursor halaman berikutnya dari X-Next-Cursor atau next_cursor respons sebelumnya dengan filter yang sama; kursor ini membawa ukuran halaman. Bersama offset: 422 validation.failed; kursor dari daftar lain, dengan filter lain, atau kursor yang rusak: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Hanya objek dengan updated_at pada saat ini atau sesudahnya (RFC 3339 dengan offset), untuk sinkronisasi. Dengan parameter ini, daftar diurutkan menurut updated_at secara menaik, lalu menurut id, dan kursor berlanjut dalam urutan itu. Objek yang dihapus tidak dicantumkan: penghapusan datang sebagai peristiwa.

    length ≤ 512

  • metadatamap of string

    Filter menurut metadata: metadata[<key>]=<value> mencocokkan secara persis. Hingga 3 kondisi, dan semuanya harus cocok (?metadata[team]=support&metadata[crm_id]=A-1042). Lebih dari 3 kondisi atau kunci yang tidak valid mengembalikan 400 api.metadata_invalid.

Respons

200Respons berhasil

Header respons

  • Link

    Alamat halaman berikutnya, <…>; rel="next". Jika header tidak ada, ini halaman terakhir.

  • X-Next-Cursor

    Kursor halaman berikutnya untuk parameter cursor. Jika header tidak ada, ini halaman terakhir.

  • RateLimit-Policy

    Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.

  • RateLimit

    Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).

  • X-RateLimit-Remaining

    Sisa permintaan dalam batas paling ketat.

  • X-RateLimit-Reset

    Detik hingga batas paling ketat direset.

application/json

Objek: FolderTreeList

array of FolderTree
  • collection_idintegerwajib
  • collection_namestringwajib
  • collection_titlestringwajib

    Nama koleksi untuk tampilan.

  • permissionsarray of stringwajib

    Izin efektif pengguna pada koleksi.

  • unfiledintegerwajib

    Kartu koleksi yang tersedia bagi pengguna dan tidak berada di folder mana pun. Kartu yang diarsipkan tidak dihitung, seperti di daftar kartu default.

  • foldersarray of FolderNodewajib
401Kredensial tidak dikirim (baik cookie sesi maupun kunci API), atau kunci tidak ditemukan.

Header respons

  • RateLimit-Policy

    Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.

  • RateLimit

    Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).

  • X-RateLimit-Remaining

    Sisa permintaan dalam batas paling ketat.

  • X-RateLimit-Reset

    Detik hingga batas paling ketat direset.

application/json

Objek: Error

429Terlalu banyak permintaan (`api.rate_limited`), kuota organisasi untuk menit, hari, atau bulan sudah habis (`api.quota_exceeded`; `error.details` berisi `quota`, `limit`, dan `reset_at`), batas organisasi tercapai, atau layanan jawaban sedang sibuk (`answers.engine_busy`). Tunggu selama waktu di header `Retry-After`.

Header respons

  • Retry-After

    Jumlah detik yang perlu ditunggu sebelum Anda mencoba ulang permintaan.

  • RateLimit-Policy

    Batas yang berlaku, dalam format draf IETF draft-ietf-httpapi-ratelimit-headers: item yang dipisahkan koma "<name>";q=<quota>;w=<window in seconds>. key adalah laju permintaan kunci API (kuotanya adalah lonjakan, jendela waktunya adalah waktu untuk mengisinya kembali sepenuhnya; untuk sesi nilainya user, tanpa kredensial ip); minute, day, dan month adalah kuota organisasi untuk menit, hari, dan bulan kalender dalam UTC.

  • RateLimit

    Sisa setiap batas di RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Batas dari entri paling ketat di RateLimit-Policy (entri dengan sisa permintaan paling sedikit).

  • X-RateLimit-Remaining

    Sisa permintaan dalam batas paling ketat.

  • X-RateLimit-Reset

    Detik hingga batas paling ketat direset.

application/json

Objek: Error

Kode error

Kode yang dapat dikembalikan endpoint ini di error.code, selain kode umum yang berlaku untuk setiap permintaan.

Batas laju

Respons berisi header RateLimit dan RateLimit-Policy serta header lama X-RateLimit-Limit, X-RateLimit-Remaining, dan X-RateLimit-Reset. Respons 429 berisi Retry-After dalam detik: tunggu, lalu coba lagi.

← folders · Referensi API