v3

latestOpenAPI 3.0.02026-07-31800117.7 KB

Capabilities

documents.search

Search, filter, and retrieve user's documents. Supports text search, filtering by document type, export status, date ranges, sorting, and semantic similarity. Use documents.count for totals or grouped summaries across all matching documents.

post/capabilities/documents.search

Request body

querystring

Text query (used only when useSearch=true). Omit in filter-only mode.

limitnumber

Max documents to return

sortBystring

Sort field (docDate, amount, merchant, ...)

sortOrdernumber

Sort order: 1 asc, -1 desc

useSearchboolean

Enable semantic/text search

searchType'similarity' | 'mmr'

Search mode when useSearch=true: similarity (exact-ish) or mmr (broader)

exportStatus'all' | 'exported' | 'not-exported'

Export status filter

archived'exclude' | 'only' | 'include'

Archive filter: exclude (default, active docs), only (archived docs), include (both).

outputMode'compact' | 'complete'

Response shape: compact (default) or complete

requiredFieldsstring[]

Always include these extra fields (in addition to outputMode defaults). Allowed fields: id, merchant, amount, currency, preferredCurrency, conversionRate, date, docDate, receivedAt, category, docType, summary, expenseLocation, invoiceId, receiptId, paymentStatus, entityId, entityName, exportStatus, link.

Response

Successful response

successboolean

codeinteger

Example response

{
  "success": true,
  "code": 200
}