Langsung ke konten
Sursa Developers

GET/v1/cards

Tampilkan daftar kartu

list_cards

Mengembalikan kartu dengan filter, pengurutan, dan paginasi. Dengan preview=1 (untuk tampilan ubin), setiap kartu juga memiliki preview (200 karakter pertama teks) dan preview_tables (lembar beserta jumlah barisnya), dalam batas profil data Anda.

Autentikasi

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

Parameter kueri

  • collectionstring | null
  • folderstring | null

    <folder ID> mengembalikan kartu dari folder dan semua subfoldernya. none mengembalikan kartu koleksi yang tidak berada di folder mana pun dan memerlukan collection (jika tidak, 400 cards.invalid_folder_filter). Jika folder tidak ada atau tidak terlihat oleh Anda, permintaan mengembalikan 404 folders.not_found.

    length ≤ 64

  • statusstring | null

    Nilai yang diizinkan: processingreadyerrorarchivedall

  • ownerstring | null

    me, none, atau ID pengguna.

  • owner_idinteger | null
  • verificationstring | null

    Nilai yang diizinkan: verifiedneeds_verificationstale

  • kindCardKind
  • typestring | null

    table mengembalikan kartu dengan tabel fakta, text mengembalikan kartu tanpa tabel fakta.

    Nilai yang diizinkan: tabletext

  • tagsstring | null

    Tag yang dipisahkan koma (kartu harus memiliki semuanya).

  • idsstring | null

    ID kartu yang dipisahkan koma.

  • searchstring | null
  • categorystring | null
  • sensitiveboolean | null
  • sortCardSort

    Default: "created_at"

  • orderstring

    Nilai yang diizinkan: ascdesc

    Default: "desc"

  • limitinteger

    Default: 200

  • offsetinteger

    Default: 0

  • previewboolean

    true menambahkan preview (200 karakter pertama) dan preview_tables untuk tampilan ubin.

    Default: false

  • updated_sincestring (date-time)

    Hanya kartu dengan updated_at pada atau setelah titik waktu ini (RFC 3339 dengan offset), untuk sinkronisasi. Tanpa sort dan order eksplisit, daftar diurutkan menurut updated_at secara menaik, lalu menurut id. Kartu yang dihapus tidak dicantumkan: penghapusan datang sebagai peristiwa.

  • 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.

  • collection_idinteger

    Koleksi menurut ID. Jika collection juga diteruskan, collection_id yang berlaku. Koleksi yang tidak ada di organisasi atau tidak terlihat mengembalikan 404 collections.not_found.

  • external_idstring

    Hanya kartu dengan external_id ini.

  • 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

  • expand[]array of string

    Objek terkait yang disertakan dalam respons (sejak 1.62.0): path dari daftar x-expandable operasi. Ulangi parameter ini hingga 10 kali. Path memiliki hingga 2 segmen yang dipisahkan titik (collection.default_owner). Dalam daftar, path diawali dengan data. dan berlaku untuk setiap item di halaman (expand[]=data.owner). Objek yang diperluas masuk ke objek expanded milik item, dan field ID tetap ada. Objek yang tidak boleh dilihat pemanggil menurut pemeriksaan operasi bacanya sendiri diperluas sebagai null. Path yang tidak dikenal, lebih dari 10 path, atau path yang lebih dari 2 segmen mengembalikan 400 api.expand_invalid.

    items ≤ 10

Parameter header

  • X-View-Asstring

    Hanya untuk kunci API dengan peran admin. Menjalankan permintaan sebagai profil data <profile>[:viewer|verifier|editor], misalnya employee:viewer. Kunci instalasi tidak dapat memakai header ini (403).

Parameter cookie

  • kb_view_asstring

    Cookie mode “View as” (Lihat sebagai) untuk sesi. POST /auth/view-as menetapkannya dan DELETE /auth/view-as menghapusnya.

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: CardList

array of Card
  • expandedCardExpanded
  • permissionsObjectPermissionList
  • accessstring

    Nilai yang diizinkan: wholepartial

  • access_contactstring

    Siapa yang dihubungi untuk akses (hanya jika access=partial).

  • aclobject
    Field
    • verifybooleanwajib
    • writebooleanwajib
  • categorystringwajib
  • category_confidencenumber | nullwajib
  • category_lockedbooleanwajib
  • category_reviewbooleanwajib
  • category_sourceCategorySource | nullwajib
  • collectionstringwajib
  • collection_idintegerwajib
  • collection_titlestring
  • commentsarray of CardComment
  • content_jsonContentJSON | null

    Konten editor dari versi terbitan terbaru. Field ini bisa tidak ada; dalam hal itu, ambil konten editor dari draf (POST /v1/drafts dengan card_id).

  • editing_lockEditingLock | null

    Kunci penyuntingan yang aktif. Field ini bisa tidak ada; dalam hal itu, editor mengetahui siapa yang memegang kunci dari 409 cards.locked pada POST /v1/cards/{card_id}/lock.

  • created_atstring (date-time)wajib
  • days_since_verifiedintegerwajib
  • errorstring | nullwajib
  • eventsarray of CardEvent
  • feedback_negintegerwajib
  • feedback_posintegerwajib
  • foldersarray of CardFolderRef

    Hanya di daftar kartu: folder yang berisi kartu (yang terlihat oleh pengguna), dengan path-nya dari akar koleksi. Daftar kosong berarti kartu tidak berada di folder mana pun.

  • has_tablesboolean

    Hanya di daftar kartu.

  • hidden_partsboolean
  • idstringwajib
  • jobJob | null
  • kindCardKindwajib
  • org_idintegerwajib
  • owner_activeboolean | null
  • owner_idinteger | nullwajib
  • owner_namestring | nullwajib
  • pagesinteger | nullwajib
  • parserstring | nullwajib

    Pengurai dokumen sebagai kode netral: document (struktur lengkap: halaman, judul, tabel, halaman hasil pindaian), pdf (lapisan teks PDF), docx, xlsx, csv, markdown, html, text. Daftar dapat bertambah.

  • partsarray of CardPartwajib
  • sensitivebooleanwajib
  • sha256string | nullwajib
  • sizeintegerwajib
  • snoozed_atstring (date-time) | null
  • snoozed_byinteger | null
  • snoozed_untilstring | null
  • source_changedbooleanwajib
  • source_pathstring | nullwajib
  • source_urlstring | nullwajib
  • statusstringwajib

    Nilai yang diizinkan: processingreadyerrorarchived

  • tablesarray of CardTable
  • tagsarray of stringwajib
  • titlestringwajib
  • trustnumberwajib
  • trust_if_verifiednumber
  • trust_partsTrustPartswajib
  • updated_atstring (date-time)wajib
  • verificationVerificationwajib
  • verified_atstring (date-time) | nullwajib
  • verified_byinteger | nullwajib
  • verified_by_namestring | null
  • verifier_idsarray of integerwajib
  • verifiersarray of object
    Field
    • activebooleanwajib
    • idintegerwajib
    • namestringwajib
  • verify_interval_daysintegerwajib
  • versionintegerwajib
  • versionsarray of CardVersion
  • source_archiveArchiveSource
  • created_byinteger | null
  • manual_optionsobject

    Pengaturan penguraian manual (pratinjau).

  • doc_kindDocKind | null

    Jenis dokumen. null jika jenisnya belum ditentukan (misalnya untuk kartu yang diindeks sebelum jenis dokumen diperkenalkan).

  • doc_kind_confidencenumber | null

    Tingkat keyakinan atas jenis dokumen, dari 0 hingga 1.

  • doc_kind_sourcestring | null

    Apa yang menentukan jenisnya: aturan (rules), pengguna (manual), atau klasifikasi otomatis. Daftar dapat bertambah: perlakukan nilai yang tidak dikenal sebagai klasifikasi otomatis.

    Nilai yang diizinkan: rulesmanualnull

  • invoiceDocInvoiceExtraction | null

    Field faktur, nota kredit, atau kuitansi (hanya untuk jenis ini, dan hanya di kartu, tidak di daftar). null jika Anda tidak memiliki akses ke seluruh dokumen, karena field-nya diekstrak dari seluruh dokumen.

  • warningsarray of ReviewWarning

    Peringatan penguraian dokumen (ReviewWarning; hanya di kartu, tidak di daftar).

  • enrichmentCardEnrichmentStatus | null

    Status pengayaan (hanya di kartu, tidak di daftar). Jenis dokumen, field faktur, dan catatan keuangan ditambahkan di latar belakang setelah pengindeksan dan dapat dihitung ulang nanti; semuanya muncul di kartu setelah siap. null berarti status tidak tersedia (kartu diindeks tanpa pengayaan latar belakang).

  • external_idstring | null

    ID kartu di sistem integrator. Unik di organisasi di antara kartu yang tidak berasal dari sumber; null berarti tidak ditetapkan. /v1/cards-by-external-id/{external_id} membaca dan mengganti kartu berdasarkan ID ini.

    length ≤ 512

  • metadataMetadata
400Permintaan tidak valid: nilai parameter atau status objek tidak memungkinkan tindakan ini (`detail` berisi pesan).

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

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

403Tindakan tidak diizinkan: peran tidak memadai, tidak ada akses ke koleksi atau kartu, permintaan berjalan dalam mode “View as”, atau organisasi ditangguhkan atau dihapus (`detail` adalah objek dengan `code: org_suspended | org_deleted`).

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

404Objek tidak ada atau tidak tersedia bagi Anda. API tidak mengonfirmasi keberadaan objek yang dibatasi.

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

422Error validasi: isi atau parameter tidak sesuai dengan skema (`detail` berisi daftar error validasi), atau nilai parameter berada di luar rentang (`detail` berisi pesan).

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.

← cards · Referensi API