Documents

List all documents

Retrieve a list of documents for the authenticated team.

get/documents

Request

  • Base URL
    https://api.midday.ai
  • URL
    https://api.midday.ai/documents
  • 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

A cursor for pagination. Pass the value returned from the previous response to get the next page.

Example:20
sortstring[] nullable

Sort as [column, direction]. Currently documents are sorted by created date descending.

pageSizenumber

Number of documents to return per page.

Example:20
qstring nullable

Search query string to filter documents by text.

Example:invoice
tagsstring[] nullable

Array of tag IDs to filter documents by tags.

[
  "tag1",
  "tag2"
]
startstring nullable

Start date for filtering documents (ISO 8601 date).

Example:2024-01-01
endstring nullable

End date for filtering documents (ISO 8601 date).

Example:2024-12-31

Response

Retrieve a list of documents for the authenticated team.

Example response

{
  "meta": {
    "cursor": "20",
    "hasPreviousPage": false,
    "hasNextPage": true
  },
  "data": [
    {
      "id": "doc_1234567890abcdef",
      "title": "Invoice April 2024",
      "pathTokens": [
        "invoices",
        "2024",
        "april",
        "invoice-123.pdf"
      ],
      "metadata": {
        "size": 204800,
        "mimetype": "application/pdf"
      },
      "processingStatus": "processed",
      "summary": "Invoice for April 2024, total $1,200.00",
      "date": "2024-04-30"
    }
  ]
}

Changes

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