Search

Search

Search across all data, invoices, documents, customers, transactions, and more.

get/search

Request

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

Query parameters

searchTermstring

The term to search for across all data sources.

Example:Acme
languagestring

Language code to use for search relevance and results.

Example:en
limitnumber

Maximum number of results to return.

Example:30
itemsPerTableLimitnumber

Maximum number of results to return per table/entity.

Example:5
relevanceThresholdnumber nullable

Minimum relevance score threshold for including a result.

Example:0.01

Response

Search results.

idstring required

Unique identifier for the search result item.

typestring required

Type of the entity returned (e.g., invoice, customer, transaction).

relevancenumber required

Relevance score for the search result.

created_atstring required

ISO 8601 timestamp when the entity was created.

dataunknown

Example response

[
  {
    "id": "b3b7e6e2-8c2a-4e2a-9b1a-2e4b5c6d7f8a",
    "type": "invoice",
    "relevance": 0.92,
    "created_at": "2024-06-01T00:00:00.000Z",
    "data": {
      "invoiceNumber": "INV-2024-001",
      "customerName": "Acme Corporation",
      "amount": 1500.75
    }
  }
]

Changes

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