Inbox

List all inbox items

Retrieve a list of inbox items for the authenticated team.

get/inbox

Request

  • Base URL
    https://api.midday.ai
  • URL
    https://api.midday.ai/inbox
  • Auth
    • OAuth 2
      Authorization code: https://app.midday.ai/oauth/authorize
      Token URL: https://api.midday.ai/oauth/token
    • or HTTP bearer

Query parameters

cursorstring nullable

Pagination cursor from previous response

orderstring nullable

Sort direction: asc or desc

sortstring nullable

Sort field. Valid values: alphabetical, document_date. Defaults to created date.

pageSizenumber

Number of items per page (1-100)

qstring nullable

Search query to filter inbox items

status'done' | 'pending' | 'suggested_match' | 'no_match' | 'other' | 'null' nullable

Filter by processing status: done (processed), pending (awaiting action), suggested_match (auto-matched), no_match (unmatched), other

tab'all' | 'other' | 'null' nullable

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"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.