List all inbox items
Retrieve a list of inbox items for the authenticated team.
Query parameters
Pagination cursor from previous response
Pagination cursor from previous response
Sort direction: asc or desc
Sort direction: asc or desc
Sort field. Valid values: alphabetical, document_date. Defaults to created date.
Sort field. Valid values: alphabetical, document_date. Defaults to created date.
Number of items per page (1-100)
Number of items per page (1-100)
Search query to filter inbox items
Search query to filter inbox items
Filter by processing status: done (processed), pending (awaiting action), suggested_match (auto-matched), no_match (unmatched), other
Filter by processing status: done (processed), pending (awaiting action), suggested_match (auto-matched), no_match (unmatched), other
Tab filter: all or other
Tab filter: all or other
Response
Retrieve a list of inbox items for the authenticated team.
Example response
{
"meta": {
"cursor": "b3b7c1e2-4c2a-4e7a-9c1a-2b7c1e24c2a4",
"hasNextPage": true
},
"data": [
{
"id": "b3b7c1e2-4c2a-4e7a-9c1a-2b7c1e24c2a4",
"fileName": "invoice-123.pdf",
"filePath": [
"inbox",
"2024",
"05",
"invoice-123.pdf"
],
"displayName": "Invoice May 2024",
"amount": 123.45,
"currency": "USD",
"contentType": "application/pdf",
"date": "2024-05-01",
"status": "pending",
"createdAt": "2024-05-01T12:34:56.789Z",
"website": "https://vendor.com",
"description": "Invoice for May 2024 services",
"transaction": {
"id": "a1b2c3d4-5678-4e7a-9c1a-2b7c1e24c2a4",
"amount": 123.45,
"currency": "USD",
"name": "Acme Corp",
"date": "2024-05-01"
}
}
]
}