list_agent_inbox
Deprecated: use search_inbound_items. Still served unchanged during the alias window. List/search current assigned postal mail using the same /v1/agent-inbox service.
Instructions
Deprecated: use search_inbound_items. Still served unchanged during the alias window. List/search current assigned postal mail using the same /v1/agent-inbox service. q is literal AND search of IDs, stored metadata and authorized stored OCR (NFKC/lowercase, max 200 characters and 12 terms), before pagination; nonempty q additionally needs agent.read. When indexed-source reads are enabled for the account, indexed search includes saved exterior and requested-content pages, including later sample captures. Optional received_after (inclusive) and received_before (exclusive) require that rollout and both read scopes; they filter the stored intake timestamp, never a date guessed from a letter. Sender/address keywords use q and OCR evidence, not an invented sender field. Returns metadata, not text. No fuzzy search or new OCR. Sandbox sees isolated fixtures and enabled assigned member samples; Live sees approved assigned private mail. Read selected matches using get_agent_inbox_sources after indexed rollout, not the original sample /context. Follow pagination.next_offset only while <=10000; narrow query/date windows before exceeding the cap and report incomplete results. Required scopes: agent.inbox.read. Agent-scoped bearer key required; member/facility keys cannot impersonate an agent. Rollout switches, current member approval, assignment, credential environment and SQL authorization are shared with REST. Never substitute another key or mail API after denial.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Literal AND search: every term (max 12, 200 characters, NFKC-normalized and lowercased) must appear in the reference, the sender line or the OCR text of a readable page. Not fuzzy; punctuation is literal. | |
| limit | No | Page size, 1–50 (default 25). | |
| offset | No | Items to skip, 0–10000 (default 0). Advance by the number returned while more remain; results are a current view, not a snapshot. | |
| received_after | No | Inclusive intake time (ISO 8601 with offset): when the facility logged the item, never a printed date. | |
| received_before | No | Exclusive intake time (ISO 8601 with offset); must be after received_after. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |