Skip to main content
POST
/
capabilities
/
documents.search
documents.search
curl --request POST \
  --url https://developer.api.receiptor.ai/v1/capabilities/documents.search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>",
  "limit": 5,
  "sortBy": "docDate",
  "sortOrder": -1,
  "where": {
    "conditions": [
      {
        "field": "amount",
        "op": "eq",
        "value": "<unknown>"
      }
    ],
    "logic": "and"
  },
  "useSearch": true,
  "searchType": "mmr",
  "exportStatus": "all",
  "archived": "exclude",
  "outputMode": "compact",
  "requiredFields": []
}
'
{
  "success": true,
  "code": 200,
  "data": {
    "result": {}
  }
}

Authorizations

​
x-api-key
string
header
required

API key prefixed with sk_. Obtain from the Receiptor AI dashboard.

Body

application/json
​
query
string

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

​
limit
number
default:5

Max documents to return

​
sortBy
string
default:docDate

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

​
sortOrder
number
default:-1

Sort order: 1 asc, -1 desc

​
where
object

Typed filter clause. Allowed fields: amount, docDate, merchant, category, docType, invoiceId, receiptId, preferredCurrency, currency, paymentMethod, paymentMethodEnding, fromEmail, toEmail, summary, taxAmount, subtotal, isRecurring, recurringType. Allowed ops: eq, ne, gt, gte, lt, lte, in, nin, regex, exists.

​
useSearch
boolean
default:true

Enable semantic/text search

​
searchType
enum<string>
default:mmr

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

Available options:
similarity,
mmr
​
exportStatus
enum<string>

Export status filter

Available options:
all,
exported,
not-exported
​
archived
enum<string>
default:exclude

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

Available options:
exclude,
only,
include
​
outputMode
enum<string>
default:compact

Response shape: compact (default) or complete

Available options:
compact,
complete
​
requiredFields
string[]

Always include these extra fields (in addition to outputMode defaults)

Response

Successful response

​
success
boolean
Example:

true

​
code
integer
Example:

200

​
data
object