मुख्य कंटेंट पर जाएँ
Sursa Developers

GET/v1/cards

कार्ड की सूची पाएँ

list_cards

फ़िल्टर, सॉर्टिंग और पेजिनेशन के साथ कार्ड लौटाता है। preview=1 के साथ (टाइल व्यू के लिए) हर कार्ड में preview (टेक्स्ट के पहले 200 कैरेक्टर) और preview_tables (शीट और उनकी पंक्तियों की संख्या) भी होते हैं, आपकी डेटा प्रोफ़ाइल के दायरे में।

ऑथेंटिकेशन

Authorization हेडर में API कुंजी भेजें: Authorization: Bearer <कुंजी>।

क्वेरी पैरामीटर

  • collectionstring | null
  • folderstring | null

    <folder ID> फ़ोल्डर और उसके सभी सब-फ़ोल्डरों के कार्ड लौटाता है। none कलेक्शन के वे कार्ड लौटाता है, जो किसी फ़ोल्डर में नहीं हैं, और इसके लिए collection ज़रूरी है (वरना 400 cards.invalid_folder_filter)। अगर फ़ोल्डर मौजूद नहीं है या आपको दिखाई नहीं देता, तो रिक्वेस्ट 404 folders.not_found लौटाती है।

    length ≤ 64

  • statusstring | null

    मान्य मान: processingreadyerrorarchivedall

  • ownerstring | null

    me, none या यूज़र का ID।

  • owner_idinteger | null
  • verificationstring | null

    मान्य मान: verifiedneeds_verificationstale

  • kindCardKind
  • typestring | null

    table फ़ैक्ट टेबल वाले कार्ड लौटाता है, text उनके बिना वाले कार्ड।

    मान्य मान: tabletext

  • tagsstring | null

    कॉमा से अलग टैग (कार्ड में ये सभी होने चाहिए)।

  • idsstring | null

    कॉमा से अलग कार्ड ID।

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

    डिफ़ॉल्ट: "created_at"

  • orderstring

    मान्य मान: ascdesc

    डिफ़ॉल्ट: "desc"

  • limitinteger

    डिफ़ॉल्ट: 200

  • offsetinteger

    डिफ़ॉल्ट: 0

  • previewboolean

    true टाइल व्यू के लिए preview (पहले 200 कैरेक्टर) और preview_tables जोड़ता है।

    डिफ़ॉल्ट: false

  • updated_sincestring (date-time)

    सिर्फ़ वे कार्ड, जिनका updated_at इस पल पर या उसके बाद का है (ऑफ़सेट के साथ RFC 3339), सिंक के लिए। स्पष्ट sort और order के बिना सूची updated_at के बढ़ते क्रम में, फिर id के क्रम में होती है। हटाए गए कार्ड सूची में नहीं आते: हटाए जाने की सूचना इवेंट से आती है।

  • metadatamap of string

    metadata से फ़िल्टर: metadata[<key>]=<value> सिर्फ़ पूरे मेल पर चुनता है। ज़्यादा से ज़्यादा 3 शर्तें, और सभी पूरी होनी चाहिए (?metadata[team]=support&metadata[crm_id]=A-1042)। 3 से ज़्यादा शर्तें या अमान्य कुंजी होने पर 400 api.metadata_invalid लौटता है।

  • collection_idinteger

    ID से कलेक्शन। collection भी दिया जाए, तो collection_id को प्राथमिकता मिलती है। जो कलेक्शन संगठन में नहीं है या दिखाई नहीं देता, उसके लिए 404 collections.not_found लौटता है।

  • external_idstring

    सिर्फ़ इस external_id वाला कार्ड।

  • cursorstring

    अगले पेज का कर्सर, X-Next-Cursor से या उन्हीं फ़िल्टर वाले पिछले रिस्पॉन्स के next_cursor से; इसमें पेज का आकार शामिल होता है। offset के साथ: 422 validation.failed; दूसरी सूची का, दूसरे फ़िल्टर वाला या ख़राब कर्सर: 400 api.cursor_invalid।

    length ≤ 512

  • expand[]array of string

    रिस्पॉन्स में शामिल किए जाने वाले जुड़े ऑब्जेक्ट (1.62.0 से): ऑपरेशन की x-expandable सूची का कोई पाथ। पैरामीटर को 10 बार तक दोहराएँ। पाथ में बिंदु से अलग किए गए 2 हिस्से तक होते हैं (collection.default_owner)। सूची में पाथ data. से शुरू होता है और पेज के हर आइटम पर लागू होता है (expand[]=data.owner)। एक्सपैंड किया गया ऑब्जेक्ट आइटम के expanded ऑब्जेक्ट में जाता है, और ID वाला फ़ील्ड बना रहता है। जिस ऑब्जेक्ट को कॉल करने वाला उसके अपने पढ़ने वाले ऑपरेशन की जाँचों के तहत नहीं देख सकता, वह null के रूप में एक्सपैंड होता है। अनजान पाथ, 10 से ज़्यादा पाथ या 2 हिस्सों से ज़्यादा गहरा पाथ 400 api.expand_invalid लौटाता है।

    items ≤ 10

हेडर पैरामीटर

  • X-View-Asstring

    सिर्फ़ admin रोल वाली API कुंजियों के लिए। रिक्वेस्ट को डेटा प्रोफ़ाइल <profile>[:viewer|verifier|editor] की ओर से चलाता है, जैसे employee:viewer। इंस्टॉलेशन कुंजी इस हेडर का इस्तेमाल नहीं कर सकती (403)।

कुकी पैरामीटर

  • kb_view_asstring

    सेशन के लिए “View as” मोड की कुकी। POST /auth/view-as इसे सेट करता है और DELETE /auth/view-as हटाता है।

रिस्पॉन्स

200सफल रिस्पॉन्स

रिस्पॉन्स हेडर

  • Link

    अगले पेज का पता, <…>; rel="next"। हेडर न हो, तो यह आख़िरी पेज है।

  • X-Next-Cursor

    cursor पैरामीटर के लिए अगले पेज का कर्सर। हेडर न हो, तो यह आख़िरी पेज है।

  • RateLimit-Policy

    लागू सीमाएँ, IETF ड्राफ़्ट draft-ietf-httpapi-ratelimit-headers के फ़ॉर्मेट में: कॉमा से अलग आइटम "<name>";q=<quota>;w=<window in seconds>। key API कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यह user है, बिना क्रेडेंशियल के ip); minute, day और month UTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।

  • RateLimit

    RateLimit-Policy की हर सीमा में से कितना बचा है: "<name>";r=<remaining>;t=<seconds until reset>।

  • X-RateLimit-Limit

    RateLimit-Policy की सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।

  • X-RateLimit-Remaining

    सबसे सख़्त सीमा में बची रिक्वेस्ट।

  • X-RateLimit-Reset

    सबसे सख़्त सीमा के रीसेट होने तक के सेकंड।

application/json

ऑब्जेक्ट: CardList

array of Card
  • expandedCardExpanded
  • permissionsObjectPermissionList
  • accessstring

    मान्य मान: wholepartial

  • access_contactstring

    ऐक्सेस के लिए किससे संपर्क करें (सिर्फ़ access=partial होने पर)।

  • aclobject
    फ़ील्ड
    • verifybooleanज़रूरी
    • writebooleanज़रूरी
  • categorystringज़रूरी
  • category_confidencenumber | nullज़रूरी
  • category_lockedbooleanज़रूरी
  • category_reviewbooleanज़रूरी
  • category_sourceCategorySource | nullज़रूरी
  • collectionstringज़रूरी
  • collection_idintegerज़रूरी
  • collection_titlestring
  • commentsarray of CardComment
  • content_jsonContentJSON | null

    नवीनतम प्रकाशित वर्शन का एडिटर कंटेंट। यह फ़ील्ड न भी हो सकता है; उस स्थिति में एडिटर कंटेंट ड्राफ़्ट से लें (card_id के साथ POST /v1/drafts)।

  • editing_lockEditingLock | null

    एडिटिंग का सक्रिय लॉक। यह फ़ील्ड न भी हो सकता है; उस स्थिति में एडिटर को POST /v1/cards/{card_id}/lock पर मिले 409 cards.locked से पता चलता है कि लॉक किसके पास है।

  • created_atstring (date-time)ज़रूरी
  • days_since_verifiedintegerज़रूरी
  • errorstring | nullज़रूरी
  • eventsarray of CardEvent
  • feedback_negintegerज़रूरी
  • feedback_posintegerज़रूरी
  • foldersarray of CardFolderRef

    सिर्फ़ कार्ड की सूची में: वे फ़ोल्डर, जिनमें कार्ड है (जो यूज़र को दिखते हैं), कलेक्शन के रूट से उनके पाथ के साथ। ख़ाली सूची का मतलब है कि कार्ड किसी फ़ोल्डर में नहीं है।

  • has_tablesboolean

    सिर्फ़ कार्ड की सूची में।

  • hidden_partsboolean
  • idstringज़रूरी
  • jobJob | null
  • kindCardKindज़रूरी
  • org_idintegerज़रूरी
  • owner_activeboolean | null
  • owner_idinteger | nullज़रूरी
  • owner_namestring | nullज़रूरी
  • pagesinteger | nullज़रूरी
  • parserstring | nullज़रूरी

    न्यूट्रल कोड के रूप में दस्तावेज़ पार्सर: document (पूरी संरचना: पेज, शीर्षक, टेबल, स्कैन किए गए पेज), pdf (PDF की टेक्स्ट लेयर), docx, xlsx, csv, markdown, html, text। यह सूची बढ़ सकती है।

  • partsarray of CardPartज़रूरी
  • sensitivebooleanज़रूरी
  • sha256string | nullज़रूरी
  • sizeintegerज़रूरी
  • snoozed_atstring (date-time) | null
  • snoozed_byinteger | null
  • snoozed_untilstring | null
  • source_changedbooleanज़रूरी
  • source_pathstring | nullज़रूरी
  • source_urlstring | nullज़रूरी
  • statusstringज़रूरी

    मान्य मान: processingreadyerrorarchived

  • tablesarray of CardTable
  • tagsarray of stringज़रूरी
  • titlestringज़रूरी
  • trustnumberज़रूरी
  • trust_if_verifiednumber
  • trust_partsTrustPartsज़रूरी
  • updated_atstring (date-time)ज़रूरी
  • verificationVerificationज़रूरी
  • verified_atstring (date-time) | nullज़रूरी
  • verified_byinteger | nullज़रूरी
  • verified_by_namestring | null
  • verifier_idsarray of integerज़रूरी
  • verifiersarray of object
    फ़ील्ड
    • activebooleanज़रूरी
    • idintegerज़रूरी
    • namestringज़रूरी
  • verify_interval_daysintegerज़रूरी
  • versionintegerज़रूरी
  • versionsarray of CardVersion
  • source_archiveArchiveSource
  • created_byinteger | null
  • manual_optionsobject

    पार्सिंग की मैन्युअल सेटिंग्स (प्रीव्यू)।

  • doc_kindDocKind | null

    दस्तावेज़ का टाइप। टाइप तय न हो, तो null (उदाहरण के लिए, उन कार्ड के लिए, जो दस्तावेज़ टाइप आने से पहले इंडेक्स हुए थे)।

  • doc_kind_confidencenumber | null

    दस्तावेज़ के टाइप पर भरोसे का स्तर, 0 से 1 तक।

  • doc_kind_sourcestring | null

    टाइप किसने तय किया: नियम (rules), यूज़र (manual) या अपने-आप होने वाला वर्गीकरण। यह सूची बढ़ सकती है: अज्ञात मान को अपने-आप होने वाला वर्गीकरण मानें।

    मान्य मान: rulesmanualnull

  • invoiceDocInvoiceExtraction | null

    इनवॉइस, क्रेडिट नोट या रसीद के फ़ील्ड (सिर्फ़ इन टाइप के लिए, और सिर्फ़ कार्ड में, सूची में नहीं)। अगर आपके पास पूरे दस्तावेज़ का ऐक्सेस नहीं है, तो null, क्योंकि फ़ील्ड पूरे दस्तावेज़ से निकाले जाते हैं।

  • warningsarray of ReviewWarning

    दस्तावेज़ पार्सिंग की चेतावनियाँ (ReviewWarning; सिर्फ़ कार्ड में, सूची में नहीं)।

  • enrichmentCardEnrichmentStatus | null

    एनरिचमेंट का स्टेटस (सिर्फ़ कार्ड में, सूची में नहीं)। दस्तावेज़ का टाइप, इनवॉइस के फ़ील्ड और वित्तीय रिकॉर्ड इंडेक्सिंग के बाद बैकग्राउंड में जोड़े जाते हैं और बाद में दोबारा गिने जा सकते हैं; तैयार होने पर वे कार्ड में दिखते हैं। null का मतलब है कि कोई स्टेटस उपलब्ध नहीं है (कार्ड बैकग्राउंड एनरिचमेंट के बिना इंडेक्स हुआ था)।

  • external_idstring | null

    इंटीग्रेटर के सिस्टम में कार्ड का ID। यह संगठन में उन कार्ड के बीच यूनीक होता है, जो स्रोतों से नहीं आते; null का मतलब है कि यह सेट नहीं है। /v1/cards-by-external-id/{external_id} इसी से कार्ड पढ़ता और बदलता है।

    length ≤ 512

  • metadataMetadata
400रिक्वेस्ट अमान्य है: पैरामीटर का मान या ऑब्जेक्ट की स्थिति यह कार्रवाई करने नहीं देती (`detail` एक संदेश है)।

रिस्पॉन्स हेडर

  • RateLimit-Policy

    लागू सीमाएँ, IETF ड्राफ़्ट draft-ietf-httpapi-ratelimit-headers के फ़ॉर्मेट में: कॉमा से अलग आइटम "<name>";q=<quota>;w=<window in seconds>। key API कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यह user है, बिना क्रेडेंशियल के ip); minute, day और month UTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।

  • RateLimit

    RateLimit-Policy की हर सीमा में से कितना बचा है: "<name>";r=<remaining>;t=<seconds until reset>।

  • X-RateLimit-Limit

    RateLimit-Policy की सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।

  • X-RateLimit-Remaining

    सबसे सख़्त सीमा में बची रिक्वेस्ट।

  • X-RateLimit-Reset

    सबसे सख़्त सीमा के रीसेट होने तक के सेकंड।

application/json

ऑब्जेक्ट: Error

401कोई क्रेडेंशियल नहीं भेजा गया (न सेशन कुकी, न API कुंजी), या कुंजी नहीं मिली।

रिस्पॉन्स हेडर

  • RateLimit-Policy

    लागू सीमाएँ, IETF ड्राफ़्ट draft-ietf-httpapi-ratelimit-headers के फ़ॉर्मेट में: कॉमा से अलग आइटम "<name>";q=<quota>;w=<window in seconds>। key API कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यह user है, बिना क्रेडेंशियल के ip); minute, day और month UTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।

  • RateLimit

    RateLimit-Policy की हर सीमा में से कितना बचा है: "<name>";r=<remaining>;t=<seconds until reset>।

  • X-RateLimit-Limit

    RateLimit-Policy की सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।

  • X-RateLimit-Remaining

    सबसे सख़्त सीमा में बची रिक्वेस्ट।

  • X-RateLimit-Reset

    सबसे सख़्त सीमा के रीसेट होने तक के सेकंड।

application/json

ऑब्जेक्ट: Error

403कार्रवाई की अनुमति नहीं है: रोल काफ़ी नहीं है, कलेक्शन या कार्ड तक ऐक्सेस नहीं है, रिक्वेस्ट “View as” मोड में चल रही है, या संगठन निलंबित है या हटा दिया गया है (`detail` एक ऑब्जेक्ट है, जिसमें `code: org_suspended | org_deleted` है)।

रिस्पॉन्स हेडर

  • RateLimit-Policy

    लागू सीमाएँ, IETF ड्राफ़्ट draft-ietf-httpapi-ratelimit-headers के फ़ॉर्मेट में: कॉमा से अलग आइटम "<name>";q=<quota>;w=<window in seconds>। key API कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यह user है, बिना क्रेडेंशियल के ip); minute, day और month UTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।

  • RateLimit

    RateLimit-Policy की हर सीमा में से कितना बचा है: "<name>";r=<remaining>;t=<seconds until reset>।

  • X-RateLimit-Limit

    RateLimit-Policy की सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।

  • X-RateLimit-Remaining

    सबसे सख़्त सीमा में बची रिक्वेस्ट।

  • X-RateLimit-Reset

    सबसे सख़्त सीमा के रीसेट होने तक के सेकंड।

application/json

ऑब्जेक्ट: Error

404ऑब्जेक्ट मौजूद नहीं है या आपके लिए उपलब्ध नहीं है। API यह पुष्टि नहीं करता कि प्रतिबंधित ऑब्जेक्ट मौजूद है।

रिस्पॉन्स हेडर

  • RateLimit-Policy

    लागू सीमाएँ, IETF ड्राफ़्ट draft-ietf-httpapi-ratelimit-headers के फ़ॉर्मेट में: कॉमा से अलग आइटम "<name>";q=<quota>;w=<window in seconds>। key API कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यह user है, बिना क्रेडेंशियल के ip); minute, day और month UTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।

  • RateLimit

    RateLimit-Policy की हर सीमा में से कितना बचा है: "<name>";r=<remaining>;t=<seconds until reset>।

  • X-RateLimit-Limit

    RateLimit-Policy की सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।

  • X-RateLimit-Remaining

    सबसे सख़्त सीमा में बची रिक्वेस्ट।

  • X-RateLimit-Reset

    सबसे सख़्त सीमा के रीसेट होने तक के सेकंड।

application/json

ऑब्जेक्ट: Error

422वैलिडेशन एरर: बॉडी या पैरामीटर स्कीमा से मेल नहीं खाते (`detail` वैलिडेशन एरर की सूची है), या पैरामीटर का मान सीमा से बाहर है (`detail` एक संदेश है)।

रिस्पॉन्स हेडर

  • RateLimit-Policy

    लागू सीमाएँ, IETF ड्राफ़्ट draft-ietf-httpapi-ratelimit-headers के फ़ॉर्मेट में: कॉमा से अलग आइटम "<name>";q=<quota>;w=<window in seconds>। key API कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यह user है, बिना क्रेडेंशियल के ip); minute, day और month UTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।

  • RateLimit

    RateLimit-Policy की हर सीमा में से कितना बचा है: "<name>";r=<remaining>;t=<seconds until reset>।

  • X-RateLimit-Limit

    RateLimit-Policy की सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।

  • X-RateLimit-Remaining

    सबसे सख़्त सीमा में बची रिक्वेस्ट।

  • X-RateLimit-Reset

    सबसे सख़्त सीमा के रीसेट होने तक के सेकंड।

application/json

ऑब्जेक्ट: Error

429बहुत ज़्यादा रिक्वेस्ट (`api.rate_limited`), संगठन का मिनट, दिन या महीने का कोटा ख़त्म हो गया है (`api.quota_exceeded`; `error.details` में `quota`, `limit` और `reset_at` होते हैं), संगठन की सीमा पूरी हो गई है, या जवाब देने वाली सर्विस व्यस्त है (`answers.engine_busy`)। `Retry-After` हेडर में दिए गए समय तक इंतज़ार करें।

रिस्पॉन्स हेडर

  • Retry-After

    रिक्वेस्ट का रीट्राई करने से पहले कितने सेकंड इंतज़ार करना है।

  • RateLimit-Policy

    लागू सीमाएँ, IETF ड्राफ़्ट draft-ietf-httpapi-ratelimit-headers के फ़ॉर्मेट में: कॉमा से अलग आइटम "<name>";q=<quota>;w=<window in seconds>। key API कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यह user है, बिना क्रेडेंशियल के ip); minute, day और month UTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।

  • RateLimit

    RateLimit-Policy की हर सीमा में से कितना बचा है: "<name>";r=<remaining>;t=<seconds until reset>।

  • X-RateLimit-Limit

    RateLimit-Policy की सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।

  • X-RateLimit-Remaining

    सबसे सख़्त सीमा में बची रिक्वेस्ट।

  • X-RateLimit-Reset

    सबसे सख़्त सीमा के रीसेट होने तक के सेकंड।

application/json

ऑब्जेक्ट: Error

एरर कोड

हर रिक्वेस्ट के सामान्य कोड के अलावा वे कोड, जो यह एंडपॉइंट एरर होने पर error.code में लौटा सकता है।

रेट लिमिट

रिस्पॉन्स में RateLimit और RateLimit-Policy हेडर होते हैं, और पहले वाले X-RateLimit-Limit, X-RateLimit-Remaining और X-RateLimit-Reset भी। 429 रिस्पॉन्स में Retry-After सेकंड में होता है: उतना इंतज़ार करें और रीट्राई करें।

← cards · API रेफ़रेंस