v1

latestOpenAPI 3.1.0AGPL-3.0 license2026-07-1210336283.6 KB

Search

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

get/search

Query parameters

searchTermstring

The term to search for across all data sources.

Example:Acme

The term to search for across all data sources.

languagestring

Language code to use for search relevance and results.

Example:en

Language code to use for search relevance and results.

limitnumber

Maximum number of results to return.

Example:30

Maximum number of results to return.

itemsPerTableLimitnumber

Maximum number of results to return per table/entity.

Example:5

Maximum number of results to return per table/entity.

relevanceThresholdnumber nullable

Minimum relevance score threshold for including a result.

Example:0.01

Minimum relevance score threshold for including a result.

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.

{"stackTrail":"paths:/search:get:responses:200:content:application/json:schema:items:properties:data","oasType":"schema","type":"unknown","description":"Additional data for the search result, structure depends on the type.","example":{"invoiceNumber":"INV-2024-001","customerName":"Acme Corporation","amount":1500.75}}

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