Preskočiť na obsah
Sursa Developers

GET/v1/cards

Zobraziť zoznam kariet

list_cards

Vráti karty s filtrami, zoradením a stránkovaním. S preview=1 (pre zobrazenie dlaždíc) má každá karta aj preview (prvých 200 znakov textu) a preview_tables (hárky s počtom riadkov), v rámci vášho dátového profilu.

Autentifikácia

Odošlite kľúč API v hlavičke Authorization: Authorization: Bearer <kľúč>.

Parametre dotazu

  • collectionstring | null
  • folderstring | null

    <folder ID> vráti karty priečinka a všetkých jeho podpriečinkov. none vráti karty kolekcie, ktoré nie sú v žiadnom priečinku, a vyžaduje collection (inak 400 cards.invalid_folder_filter). Ak priečinok neexistuje alebo ho nevidíte, požiadavka vráti 404 folders.not_found.

    length ≤ 64

  • statusstring | null

    Povolené hodnoty: processingreadyerrorarchivedall

  • ownerstring | null

    me, none alebo ID používateľa.

  • owner_idinteger | null
  • verificationstring | null

    Povolené hodnoty: verifiedneeds_verificationstale

  • kindCardKind
  • typestring | null

    table vráti karty s tabuľkami faktov, text karty bez nich.

    Povolené hodnoty: tabletext

  • tagsstring | null

    Štítky oddelené čiarkami (karta musí mať všetky).

  • idsstring | null

    ID kariet oddelené čiarkami.

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

    Predvolené: "created_at"

  • orderstring

    Povolené hodnoty: ascdesc

    Predvolené: "desc"

  • limitinteger

    Predvolené: 200

  • offsetinteger

    Predvolené: 0

  • previewboolean

    true pridá preview (prvých 200 znakov) a preview_tables pre zobrazenie dlaždíc.

    Predvolené: false

  • updated_sincestring (date-time)

    Len karty s updated_at v tomto okamihu alebo neskôr (RFC 3339 s časovým posunom), na synchronizáciu. Bez výslovne zadaných sort a order je zoznam zoradený podľa updated_at vzostupne, potom podľa id. Odstránené karty sa v zozname neuvádzajú: odstránenia prichádzajú ako udalosti.

  • metadatamap of string

    Filter podľa metadata: metadata[<key>]=<value> vyžaduje presnú zhodu. Najviac 3 podmienky, pričom musia platiť všetky (?metadata[team]=support&metadata[crm_id]=A-1042). Viac ako 3 podmienky alebo neplatný kľúč vráti 400 api.metadata_invalid.

  • collection_idinteger

    Kolekcia podľa ID. Ak je zadané aj collection, prednosť má collection_id. Kolekcia, ktorá v organizácii neexistuje alebo nie je viditeľná, vráti 404 collections.not_found.

  • external_idstring

    Len karta s týmto external_id.

  • cursorstring

    Kurzor ďalšej stránky z X-Next-Cursor alebo z next_cursor predchádzajúcej odpovede s rovnakými filtrami; nesie aj veľkosť stránky. Spolu s offset: 422 validation.failed; kurzor iného zoznamu, s inými filtrami alebo poškodený: 400 api.cursor_invalid.

    length ≤ 512

  • expand[]array of string

    Súvisiace objekty, ktoré sa majú zahrnúť do odpovede (od verzie 1.62.0): cesta zo zoznamu x-expandable operácie. Parameter zopakujte najviac 10-krát. Cesta má najviac 2 segmenty oddelené bodkou (collection.default_owner). V zozname cesta začína predponou data. a platí pre každú položku stránky (expand[]=data.owner). Rozbalený objekt sa vloží do objektu expanded položky a pole s ID zostáva. Objekt, ktorý volajúci podľa kontrol jeho vlastnej operácie čítania nesmie vidieť, sa rozbalí ako null. Neznáma cesta, viac ako 10 ciest alebo cesta s viac ako 2 segmentmi vráti 400 api.expand_invalid.

    items ≤ 10

Parametre hlavičky

  • X-View-Asstring

    Len pre kľúče API s rolou admin. Vykoná požiadavku v mene dátového profilu <profile>[:viewer|verifier|editor], napríklad employee:viewer. Inštalačný kľúč túto hlavičku použiť nemôže (403).

Parametre cookie

  • kb_view_asstring

    Súbor cookie režimu „View as“ pre reláciu. POST /auth/view-as ho nastaví a DELETE /auth/view-as ho odstráni.

Odpovede

200Úspešná odpoveď

Hlavičky odpovede

  • Link

    Adresa ďalšej stránky, <…>; rel="next". Ak hlavička chýba, ide o poslednú stránku.

  • X-Next-Cursor

    Kurzor ďalšej stránky pre parameter cursor. Ak hlavička chýba, ide o poslednú stránku.

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: CardList

array of Card
  • expandedCardExpanded
  • permissionsObjectPermissionList
  • accessstring

    Povolené hodnoty: wholepartial

  • access_contactstring

    Na koho sa obrátiť kvôli prístupu (len pri access=partial).

  • aclobject
    Polia
    • verifybooleanpovinné
    • writebooleanpovinné
  • categorystringpovinné
  • category_confidencenumber | nullpovinné
  • category_lockedbooleanpovinné
  • category_reviewbooleanpovinné
  • category_sourceCategorySource | nullpovinné
  • collectionstringpovinné
  • collection_idintegerpovinné
  • collection_titlestring
  • commentsarray of CardComment
  • content_jsonContentJSON | null

    Obsah editora poslednej publikovanej verzie. Pole môže chýbať; vtedy získajte obsah editora z návrhu (POST /v1/drafts s card_id).

  • editing_lockEditingLock | null

    Aktívny zámok úprav. Pole môže chýbať; vtedy sa editor dozvie, kto má zámok, z 409 cards.locked pri POST /v1/cards/{card_id}/lock.

  • created_atstring (date-time)povinné
  • days_since_verifiedintegerpovinné
  • errorstring | nullpovinné
  • eventsarray of CardEvent
  • feedback_negintegerpovinné
  • feedback_posintegerpovinné
  • foldersarray of CardFolderRef

    Len v zozname kariet: priečinky, ktoré kartu obsahujú (tie, ktoré používateľ vidí), s ich cestami od koreňa kolekcie. Prázdny zoznam znamená, že karta nie je v žiadnom priečinku.

  • has_tablesboolean

    Len v zozname kariet.

  • hidden_partsboolean
  • idstringpovinné
  • jobJob | null
  • kindCardKindpovinné
  • org_idintegerpovinné
  • owner_activeboolean | null
  • owner_idinteger | nullpovinné
  • owner_namestring | nullpovinné
  • pagesinteger | nullpovinné
  • parserstring | nullpovinné

    Parser dokumentu ako neutrálny kód: document (úplná štruktúra: strany, nadpisy, tabuľky, naskenované strany), pdf (textová vrstva PDF), docx, xlsx, csv, markdown, html, text. Zoznam sa môže rozširovať.

  • partsarray of CardPartpovinné
  • sensitivebooleanpovinné
  • sha256string | nullpovinné
  • sizeintegerpovinné
  • snoozed_atstring (date-time) | null
  • snoozed_byinteger | null
  • snoozed_untilstring | null
  • source_changedbooleanpovinné
  • source_pathstring | nullpovinné
  • source_urlstring | nullpovinné
  • statusstringpovinné

    Povolené hodnoty: processingreadyerrorarchived

  • tablesarray of CardTable
  • tagsarray of stringpovinné
  • titlestringpovinné
  • trustnumberpovinné
  • trust_if_verifiednumber
  • trust_partsTrustPartspovinné
  • updated_atstring (date-time)povinné
  • verificationVerificationpovinné
  • verified_atstring (date-time) | nullpovinné
  • verified_byinteger | nullpovinné
  • verified_by_namestring | null
  • verifier_idsarray of integerpovinné
  • verifiersarray of object
    Polia
    • activebooleanpovinné
    • idintegerpovinné
    • namestringpovinné
  • verify_interval_daysintegerpovinné
  • versionintegerpovinné
  • versionsarray of CardVersion
  • source_archiveArchiveSource
  • created_byinteger | null
  • manual_optionsobject

    Ručné nastavenia parsovania (náhľad).

  • doc_kindDocKind | null

    Typ dokumentu. null, ak typ nie je určený (napríklad pri kartách zaindexovaných pred zavedením typov dokumentov).

  • doc_kind_confidencenumber | null

    Miera istoty pri type dokumentu, od 0 do 1.

  • doc_kind_sourcestring | null

    Čo určilo typ: pravidlá (rules), používateľ (manual) alebo automatická klasifikácia. Zoznam sa môže rozširovať: neznámu hodnotu považujte za automatickú klasifikáciu.

    Povolené hodnoty: rulesmanualnull

  • invoiceDocInvoiceExtraction | null

    Polia faktúry, dobropisu alebo pokladničného dokladu (len pri týchto typoch a len v karte, nie v zozname). null, ak nemáte prístup k celému dokumentu, pretože polia sa vyťažujú z celého dokumentu.

  • warningsarray of ReviewWarning

    Upozornenia z parsovania dokumentu (ReviewWarning; len v karte, nie v zozname).

  • enrichmentCardEnrichmentStatus | null

    Stav obohatenia (len v karte, nie v zozname). Typ dokumentu, polia faktúry a finančné záznamy sa dopĺňajú na pozadí po indexovaní a neskôr ich možno prepočítať; v karte sa objavia, keď sú pripravené. null znamená, že stav nie je k dispozícii (karta bola zaindexovaná bez obohatenia na pozadí).

  • external_idstring | null

    ID karty v systéme integrátora. Je jedinečné v organizácii medzi kartami, ktoré nepochádzajú zo zdrojov; null znamená, že nie je nastavené. /v1/cards-by-external-id/{external_id} podľa neho kartu číta a nahrádza.

    length ≤ 512

  • metadataMetadata
400Požiadavka je neplatná: hodnota parametra alebo stav objektu akciu nedovoľuje (`detail` je správa).

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

401Neboli odoslané žiadne prihlasovacie údaje (ani cookie relácie, ani kľúč API) alebo sa kľúč nenašiel.

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

403Akcia nie je povolená: rola nestačí, chýba prístup ku kolekcii alebo karte, požiadavka beží v režime „View as“ alebo je organizácia pozastavená či odstránená (`detail` je objekt s `code: org_suspended | org_deleted`).

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

404Objekt neexistuje alebo vám nie je dostupný. API nepotvrdzuje, že objekt s obmedzeným prístupom existuje.

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

422Chyba validácie: telo alebo parametre nezodpovedajú schéme (`detail` je zoznam chýb validácie) alebo je hodnota parametra mimo rozsahu (`detail` je správa).

Hlavičky odpovede

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

429Príliš veľa požiadaviek (`api.rate_limited`), vyčerpaná kvóta organizácie na minútu, deň alebo mesiac (`api.quota_exceeded`; `error.details` obsahuje `quota`, `limit` a `reset_at`), dosiahnutý limit organizácie alebo zaneprázdnená služba odpovedí (`answers.engine_busy`). Počkajte čas uvedený v hlavičke `Retry-After`.

Hlavičky odpovede

  • Retry-After

    Počet sekúnd, ktoré treba počkať pred opakovaním požiadavky.

  • RateLimit-Policy

    Platné limity vo formáte návrhu IETF draft-ietf-httpapi-ratelimit-headers: položky oddelené čiarkami "<name>";q=<quota>;w=<window in seconds>. key je frekvencia požiadaviek kľúča API (kvóta je nárazová špička, okno je čas na jej úplné doplnenie; pre reláciu je to user, bez prihlasovacích údajov ip); minute, day a month sú kvóty organizácie na kalendárnu minútu, deň a mesiac v UTC.

  • RateLimit

    Čo zostáva z každého limitu v RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Limit najprísnejšej položky v RateLimit-Policy (tej, ktorej zostáva najmenej požiadaviek).

  • X-RateLimit-Remaining

    Počet požiadaviek, ktoré zostávajú v rámci najprísnejšieho limitu.

  • X-RateLimit-Reset

    Počet sekúnd do obnovenia najprísnejšieho limitu.

application/json

Objekt: Error

Chybové kódy

Kódy, ktoré táto operácia môže vrátiť v error.code, okrem všeobecných kódov každej požiadavky.

Limity frekvencie

Odpovede obsahujú hlavičky RateLimit a RateLimit-Policy a staršie X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset. Odpoveď 429 má hlavičku Retry-After v sekundách: počkajte a požiadavku zopakujte.

← cards · Referencia API