GET/v1/cards
แสดงรายการการ์ด
list_cards
ส่งคืนการ์ดพร้อมตัวกรอง การเรียงลำดับ และการแบ่งหน้า เมื่อใช้ preview=1 (สำหรับมุมมองแบบไทล์) การ์ดแต่ละใบจะมี preview (ข้อความ 200 อักขระแรก) และ preview_tables (ชีตพร้อมจำนวนแถว) ภายในขอบเขตโปรไฟล์ข้อมูลของคุณ
การยืนยันตัวตน
ส่งคีย์ API ในเฮดเดอร์ Authorization: Authorization: Bearer <คีย์>
พารามิเตอร์คิวรี
collectionstring | nullfolderstring | null<folder ID>ส่งคืนการ์ดของโฟลเดอร์และโฟลเดอร์ย่อยทั้งหมดnoneส่งคืนการ์ดของคอลเลกชันที่ไม่อยู่ในโฟลเดอร์ใดและต้องระบุcollection(มิฉะนั้นจะได้400 cards.invalid_folder_filter) ถ้าโฟลเดอร์ไม่มีอยู่หรือคุณมองไม่เห็น คำขอจะส่งคืน404 folders.not_foundlength ≤ 64
statusstring | nullค่าที่ใช้ได้:
processingreadyerrorarchivedallownerstring | nullmenoneหรือ ID ของผู้ใช้owner_idinteger | nullverificationstring | nullค่าที่ใช้ได้:
verifiedneeds_verificationstalekindCardKindtypestring | nulltableส่งคืนการ์ดที่มีตารางข้อเท็จจริง (fact table) ส่วนtextส่งคืนการ์ดที่ไม่มีตารางค่าที่ใช้ได้:
tabletexttagsstring | nullแท็กคั่นด้วยจุลภาค (การ์ดต้องมีครบทุกแท็ก)
idsstring | nullID ของการ์ดคั่นด้วยจุลภาค
searchstring | nullcategorystring | nullsensitiveboolean | nullsortCardSortค่าเริ่มต้น: "created_at"
orderstringค่าที่ใช้ได้:
ascdescค่าเริ่มต้น: "desc"
limitintegerค่าเริ่มต้น: 200
offsetintegerค่าเริ่มต้น: 0
previewbooleantrueเพิ่ม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_invalidcollection_idintegerคอลเลกชันตาม ID ถ้าส่ง
collectionมาด้วย ระบบจะใช้collection_idคอลเลกชันที่ไม่มีอยู่ในองค์กรหรือมองไม่เห็นจะส่งคืน404 collections.not_foundexternal_idstringเฉพาะการ์ดที่มี
external_idนี้cursorstringเคอร์เซอร์ของหน้าถัดไปจาก
X-Next-Cursorหรือnext_cursorของการตอบกลับก่อนหน้าที่ใช้ตัวกรองเดียวกัน เคอร์เซอร์มีขนาดหน้าอยู่ในตัว ถ้าใช้ร่วมกับoffset:422 validation.failedถ้าเป็นเคอร์เซอร์ของรายการอื่น ของตัวกรองอื่น หรือมีรูปแบบผิด:400 api.cursor_invalidlength ≤ 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_invaliditems ≤ 10
พารามิเตอร์เฮดเดอร์
X-View-Asstringสำหรับคีย์ API ที่มีบทบาท
adminเท่านั้น ทำคำขอในนามโปรไฟล์ข้อมูล<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 (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือuserและเมื่อไม่มีข้อมูลรับรองคือip) ส่วนminutedayและmonthคือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTCRateLimitส่วนที่เหลือของแต่ละขีดจำกัดใน
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>X-RateLimit-Limitขีดจำกัดของรายการที่เข้มงวดที่สุดใน
RateLimit-Policy(รายการที่เหลือคำขอน้อยที่สุด)X-RateLimit-Remainingจำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด
X-RateLimit-Resetจำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต
application/json
expandedCardExpandedpermissionsObjectPermissionListaccessstringค่าที่ใช้ได้:
wholepartialaccess_contactstringผู้ที่ต้องติดต่อเพื่อขอสิทธิ์เข้าถึง (เฉพาะเมื่อ
access=partial)aclobjectฟิลด์
verifybooleanจำเป็นwritebooleanจำเป็น
categorystringจำเป็นcategory_confidencenumber | nullจำเป็นcategory_lockedbooleanจำเป็นcategory_reviewbooleanจำเป็นcollectionstringจำเป็นcollection_idintegerจำเป็นcollection_titlestringcommentsarray of CardCommentcontent_jsonContentJSON | nullเนื้อหาในรูปแบบของเครื่องมือแก้ไขของเวอร์ชันที่เผยแพร่ล่าสุด ฟิลด์นี้อาจไม่มี ในกรณีนั้นให้ดึงเนื้อหาในรูปแบบของเครื่องมือแก้ไขจากฉบับร่าง (
POST /v1/draftsพร้อมcard_id)editing_lockEditingLock | nullการล็อกการแก้ไขที่มีผลอยู่ ฟิลด์นี้อาจไม่มี ในกรณีนั้น เครื่องมือแก้ไขจะทราบว่าใครถือการล็อกอยู่จาก
409 cards.lockedของPOST /v1/cards/{card_id}/lockcreated_atstring (date-time)จำเป็นdays_since_verifiedintegerจำเป็นerrorstring | nullจำเป็นeventsarray of CardEventfeedback_negintegerจำเป็นfeedback_posintegerจำเป็นfoldersarray of CardFolderRefเฉพาะในรายการการ์ด: โฟลเดอร์ที่มีการ์ดนี้อยู่ (เฉพาะที่ผู้ใช้มองเห็น) พร้อมพาธจากระดับบนสุดของคอลเลกชัน รายการว่างหมายถึงการ์ดไม่ได้อยู่ในโฟลเดอร์ใด
has_tablesbooleanเฉพาะในรายการการ์ด
hidden_partsbooleanidstringจำเป็นjobJob | nullorg_idintegerจำเป็นowner_activeboolean | nullowner_idinteger | nullจำเป็นowner_namestring | nullจำเป็นpagesinteger | nullจำเป็นparserstring | nullจำเป็นตัวแยกวิเคราะห์เอกสารเป็นรหัสกลาง:
document(โครงสร้างครบถ้วน: หน้า หัวข้อ ตาราง และหน้าที่สแกน)pdf(ชั้นข้อความของ PDF)docxxlsxcsvmarkdownhtmlและtextรายการนี้อาจมีค่าเพิ่มsensitivebooleanจำเป็นsha256string | nullจำเป็นsizeintegerจำเป็นsnoozed_atstring (date-time) | nullsnoozed_byinteger | nullsnoozed_untilstring | nullsource_changedbooleanจำเป็นsource_pathstring | nullจำเป็นsource_urlstring | nullจำเป็นstatusstringจำเป็นค่าที่ใช้ได้:
processingreadyerrorarchivedtablesarray of CardTabletagsarray of stringจำเป็นtitlestringจำเป็นtrustnumberจำเป็นtrust_if_verifiednumberupdated_atstring (date-time)จำเป็นverified_atstring (date-time) | nullจำเป็นverified_byinteger | nullจำเป็นverified_by_namestring | nullverifier_idsarray of integerจำเป็นverifiersarray of objectฟิลด์
activebooleanจำเป็นidintegerจำเป็นnamestringจำเป็น
verify_interval_daysintegerจำเป็นversionintegerจำเป็นversionsarray of CardVersionsource_archiveArchiveSourcecreated_byinteger | nullmanual_optionsobjectการตั้งค่าการแยกวิเคราะห์ด้วยตนเอง (จากตัวอย่างผลการแยกวิเคราะห์)
doc_kindDocKind | nullประเภทเอกสาร
nullถ้ายังไม่ได้ระบุประเภท (เช่น การ์ดที่ทำดัชนีก่อนมีประเภทเอกสาร)doc_kind_confidencenumber | nullความมั่นใจในประเภทเอกสาร ตั้งแต่ 0 ถึง 1
doc_kind_sourcestring | nullสิ่งที่ใช้ระบุประเภท: กฎ (
rules) ผู้ใช้ (manual) หรือการจัดประเภทอัตโนมัติ รายการนี้อาจมีค่าเพิ่ม: ให้ถือว่าค่าที่ไม่รู้จักเป็นการจัดประเภทอัตโนมัติค่าที่ใช้ได้:
rulesmanualnullinvoiceDocInvoiceExtraction | nullฟิลด์ของใบแจ้งหนี้ ใบลดหนี้ หรือใบเสร็จรับเงิน (เฉพาะประเภทเหล่านี้ และเฉพาะในการ์ด ไม่มีในรายการ) เป็น
nullถ้าคุณไม่มีสิทธิ์เข้าถึงทั้งเอกสาร เพราะระบบดึงฟิลด์จากทั้งเอกสารwarningsarray of ReviewWarningคำเตือนจากการแยกวิเคราะห์เอกสาร (
ReviewWarningเฉพาะในการ์ด ไม่มีในรายการ)enrichmentCardEnrichmentStatus | nullสถานะการเพิ่มข้อมูลประกอบ (เฉพาะในการ์ด ไม่มีในรายการ) ระบบเพิ่มประเภทเอกสาร ฟิลด์ของใบแจ้งหนี้ และรายการทางการเงินในเบื้องหลังหลังการทำดัชนี และอาจคำนวณใหม่ภายหลัง ข้อมูลเหล่านี้จะปรากฏในการ์ดเมื่อพร้อม
nullหมายถึงไม่มีสถานะ (การ์ดทำดัชนีโดยไม่มีการเพิ่มข้อมูลประกอบในเบื้องหลัง)external_idstring | nullID ของการ์ดในระบบของผู้พัฒนาระบบที่เชื่อมต่อ ไม่ซ้ำกันในองค์กรในบรรดาการ์ดที่ไม่ได้มาจากแหล่งข้อมูล
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 (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือuserและเมื่อไม่มีข้อมูลรับรองคือip) ส่วนminutedayและmonthคือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTCRateLimitส่วนที่เหลือของแต่ละขีดจำกัดใน
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>X-RateLimit-Limitขีดจำกัดของรายการที่เข้มงวดที่สุดใน
RateLimit-Policy(รายการที่เหลือคำขอน้อยที่สุด)X-RateLimit-Remainingจำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด
X-RateLimit-Resetจำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต
application/json
401ไม่ได้ส่งข้อมูลรับรอง (ไม่มีทั้งคุกกี้เซสชันและคีย์ API) หรือไม่พบคีย์
เฮดเดอร์การตอบกลับ
RateLimit-Policyขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF
draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค"<name>";q=<quota>;w=<window in seconds>โดยkeyคืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือuserและเมื่อไม่มีข้อมูลรับรองคือip) ส่วนminutedayและmonthคือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTCRateLimitส่วนที่เหลือของแต่ละขีดจำกัดใน
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>X-RateLimit-Limitขีดจำกัดของรายการที่เข้มงวดที่สุดใน
RateLimit-Policy(รายการที่เหลือคำขอน้อยที่สุด)X-RateLimit-Remainingจำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด
X-RateLimit-Resetจำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต
application/json
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 (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือuserและเมื่อไม่มีข้อมูลรับรองคือip) ส่วนminutedayและmonthคือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTCRateLimitส่วนที่เหลือของแต่ละขีดจำกัดใน
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>X-RateLimit-Limitขีดจำกัดของรายการที่เข้มงวดที่สุดใน
RateLimit-Policy(รายการที่เหลือคำขอน้อยที่สุด)X-RateLimit-Remainingจำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด
X-RateLimit-Resetจำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต
application/json
404ออบเจ็กต์ไม่มีอยู่หรือคุณเข้าถึงไม่ได้ API ไม่ยืนยันว่าออบเจ็กต์ที่จำกัดสิทธิ์มีอยู่จริง
เฮดเดอร์การตอบกลับ
RateLimit-Policyขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF
draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค"<name>";q=<quota>;w=<window in seconds>โดยkeyคืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือuserและเมื่อไม่มีข้อมูลรับรองคือip) ส่วนminutedayและmonthคือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTCRateLimitส่วนที่เหลือของแต่ละขีดจำกัดใน
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>X-RateLimit-Limitขีดจำกัดของรายการที่เข้มงวดที่สุดใน
RateLimit-Policy(รายการที่เหลือคำขอน้อยที่สุด)X-RateLimit-Remainingจำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด
X-RateLimit-Resetจำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต
application/json
422ข้อผิดพลาดในการตรวจความถูกต้องของข้อมูล: เนื้อหาหรือพารามิเตอร์ไม่ตรงกับสคีมา (`detail` เป็นรายการข้อผิดพลาดในการตรวจความถูกต้อง) หรือค่าพารามิเตอร์อยู่นอกช่วงที่กำหนด (`detail` เป็นข้อความ)
เฮดเดอร์การตอบกลับ
RateLimit-Policyขีดจำกัดที่มีผล ในรูปแบบของร่าง IETF
draft-ietf-httpapi-ratelimit-headers: รายการคั่นด้วยจุลภาค"<name>";q=<quota>;w=<window in seconds>โดยkeyคืออัตราคำขอของคีย์ API (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือuserและเมื่อไม่มีข้อมูลรับรองคือip) ส่วนminutedayและmonthคือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTCRateLimitส่วนที่เหลือของแต่ละขีดจำกัดใน
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>X-RateLimit-Limitขีดจำกัดของรายการที่เข้มงวดที่สุดใน
RateLimit-Policy(รายการที่เหลือคำขอน้อยที่สุด)X-RateLimit-Remainingจำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด
X-RateLimit-Resetจำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต
application/json
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 (โควตาคือช่วงพุ่งสูง (burst) กรอบเวลาคือเวลาที่ใช้เติมกลับจนเต็ม สำหรับเซสชันคือuserและเมื่อไม่มีข้อมูลรับรองคือip) ส่วนminutedayและmonthคือโควตาขององค์กรสำหรับนาที วัน และเดือนตามปฏิทินใน UTCRateLimitส่วนที่เหลือของแต่ละขีดจำกัดใน
RateLimit-Policy:"<name>";r=<remaining>;t=<seconds until reset>X-RateLimit-Limitขีดจำกัดของรายการที่เข้มงวดที่สุดใน
RateLimit-Policy(รายการที่เหลือคำขอน้อยที่สุด)X-RateLimit-Remainingจำนวนคำขอที่เหลือภายใต้ขีดจำกัดที่เข้มงวดที่สุด
X-RateLimit-Resetจำนวนวินาทีจนกว่าขีดจำกัดที่เข้มงวดที่สุดจะรีเซ็ต
application/json
รหัสข้อผิดพลาด
รหัสที่เอนด์พอยต์นี้อาจส่งคืนใน error.code นอกเหนือจากรหัสทั่วไปของทุกคำขอ
- 400api.expand_invalid
- 400api.metadata_invalid
- 401auth.not_authenticated
- 403auth.system_scope
- 400cards.invalid_folder_filter
- 400cards.invalid_kind_filter
- 400cards.invalid_order
- 400cards.invalid_owner_filter
- 400cards.invalid_sort
- 400cards.invalid_status_filter
- 400cards.invalid_type_filter
- 400cards.invalid_verification_filter
- 400categories.unknown
- 403collections.no_access
- 404collections.not_found
- 404folders.not_found
- 403org.deleted
- 403org.suspended
- 403view_as.read_only
ขีดจำกัดอัตราการเรียก
การตอบกลับมีเฮดเดอร์ RateLimit และ RateLimit-Policy รวมถึงเฮดเดอร์แบบเดิม X-RateLimit-Limit X-RateLimit-Remaining และ X-RateLimit-Reset การตอบกลับ 429 มี Retry-After เป็นวินาที ให้รอตามนั้นแล้วลองใหม่