Get document details and metadata
po_documents_getREAD-ONLY. Returns data, changes nothing. Get document identity, processing state and compact trust.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pofid | No | PaperOffice File ID (POFID). Copy byte-for-byte from po_documents_search. Hash prefix uses PaperOffice encoding (SHA-256 with digit 0 stored as letter O) — never replace O with 0. At least one of pofid or documents_id MUST be provided. | |
| compact | No | Compact mode (default true): core identity, classification, dates, summary, sender/recipient, amounts when present, plus capabilities and processing_state. | |
| resolve | No | Versioning: latest = return the CURRENT version of the document line even if pofid points to an older version (response.document.resolved_to_latest=true, requested_pofid keeps the input). Default exact = the given version. | exact |
| documents_id | No | Numeric document ID — alternative to pofid. At least one of pofid or documents_id MUST be provided. | |
| include_pages_ocr | No | When false (default), pages_ocr is omitted from the response — use po_documents_text_get for OCR text. Set true only when per-page OCR is required. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| text | No | ||
| pofid | No | ||
| details | No | ||
| message | No | ||
| summary | No | ||
| currency | No | ||
| _warnings | No | ||
| file_name | No | ||
| retryable | No | ||
| error_code | No | ||
| enforcement | No | ||
| http_status | No | ||
| total_pages | No | Page count on the basis named in page_count_basis: source file pages, or rendered pages for Markdown/DOCX/XLSX/EML (then total_pages_source holds the source count) | |
| capabilities | No | ||
| display_name | No | ||
| documents_id | No | ||
| total_amount | No | ||
| workspace_id | No | ||
| document_type | No | ||
| page_integrity | No | ||
| workspace_name | No | ||
| _billing_summary | No | ||
| page_count_basis | No | ||
| processing_state | No | ||
| original_file_name | No | ||
| total_pages_rendered | No | ||
| write_tools_in_profile | No | Whether the write tool is registered on this connector (not a permission) | |
| extraction_capabilities | No | ||
| effective_write_permissions | No | Document capability ∩ token ACL, enforced server-side |