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,
"useSearch": true,
"searchType": "mmr",
"archived": "exclude",
"outputMode": "compact",
"requiredFields": []
}
'import requests
url = "https://developer.api.receiptor.ai/v1/capabilities/documents.search"
payload = {
"query": "<string>",
"limit": 5,
"sortBy": "docDate",
"sortOrder": -1,
"useSearch": True,
"searchType": "mmr",
"archived": "exclude",
"outputMode": "compact",
"requiredFields": []
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
limit: 5,
sortBy: 'docDate',
sortOrder: -1,
useSearch: true,
searchType: 'mmr',
archived: 'exclude',
outputMode: 'compact',
requiredFields: []
})
};
fetch('https://developer.api.receiptor.ai/v1/capabilities/documents.search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.api.receiptor.ai/v1/capabilities/documents.search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'limit' => 5,
'sortBy' => 'docDate',
'sortOrder' => -1,
'useSearch' => true,
'searchType' => 'mmr',
'archived' => 'exclude',
'outputMode' => 'compact',
'requiredFields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.api.receiptor.ai/v1/capabilities/documents.search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"limit\": 5,\n \"sortBy\": \"docDate\",\n \"sortOrder\": -1,\n \"useSearch\": true,\n \"searchType\": \"mmr\",\n \"archived\": \"exclude\",\n \"outputMode\": \"compact\",\n \"requiredFields\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.api.receiptor.ai/v1/capabilities/documents.search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"limit\": 5,\n \"sortBy\": \"docDate\",\n \"sortOrder\": -1,\n \"useSearch\": true,\n \"searchType\": \"mmr\",\n \"archived\": \"exclude\",\n \"outputMode\": \"compact\",\n \"requiredFields\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.api.receiptor.ai/v1/capabilities/documents.search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"limit\": 5,\n \"sortBy\": \"docDate\",\n \"sortOrder\": -1,\n \"useSearch\": true,\n \"searchType\": \"mmr\",\n \"archived\": \"exclude\",\n \"outputMode\": \"compact\",\n \"requiredFields\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"code": 200,
"data": {
"result": {}
}
}{
"success": false,
"code": 400,
"error": {
"errorCode": 400,
"errorMessage": "<string>"
}
}{
"success": false,
"code": 401,
"error": {
"errorCode": 401,
"errorMessage": "API key authentication required"
}
}{
"success": false,
"code": 404,
"error": {
"errorCode": 404,
"errorMessage": "<string>"
}
}documents.search
Search, filter, and retrieve user’s documents. Supports text search, filtering by document type, export status, date ranges, sorting, and semantic similarity.
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,
"useSearch": true,
"searchType": "mmr",
"archived": "exclude",
"outputMode": "compact",
"requiredFields": []
}
'import requests
url = "https://developer.api.receiptor.ai/v1/capabilities/documents.search"
payload = {
"query": "<string>",
"limit": 5,
"sortBy": "docDate",
"sortOrder": -1,
"useSearch": True,
"searchType": "mmr",
"archived": "exclude",
"outputMode": "compact",
"requiredFields": []
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
limit: 5,
sortBy: 'docDate',
sortOrder: -1,
useSearch: true,
searchType: 'mmr',
archived: 'exclude',
outputMode: 'compact',
requiredFields: []
})
};
fetch('https://developer.api.receiptor.ai/v1/capabilities/documents.search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.api.receiptor.ai/v1/capabilities/documents.search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'limit' => 5,
'sortBy' => 'docDate',
'sortOrder' => -1,
'useSearch' => true,
'searchType' => 'mmr',
'archived' => 'exclude',
'outputMode' => 'compact',
'requiredFields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.api.receiptor.ai/v1/capabilities/documents.search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"limit\": 5,\n \"sortBy\": \"docDate\",\n \"sortOrder\": -1,\n \"useSearch\": true,\n \"searchType\": \"mmr\",\n \"archived\": \"exclude\",\n \"outputMode\": \"compact\",\n \"requiredFields\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.api.receiptor.ai/v1/capabilities/documents.search")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"limit\": 5,\n \"sortBy\": \"docDate\",\n \"sortOrder\": -1,\n \"useSearch\": true,\n \"searchType\": \"mmr\",\n \"archived\": \"exclude\",\n \"outputMode\": \"compact\",\n \"requiredFields\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.api.receiptor.ai/v1/capabilities/documents.search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"limit\": 5,\n \"sortBy\": \"docDate\",\n \"sortOrder\": -1,\n \"useSearch\": true,\n \"searchType\": \"mmr\",\n \"archived\": \"exclude\",\n \"outputMode\": \"compact\",\n \"requiredFields\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"code": 200,
"data": {
"result": {}
}
}{
"success": false,
"code": 400,
"error": {
"errorCode": 400,
"errorMessage": "<string>"
}
}{
"success": false,
"code": 401,
"error": {
"errorCode": 401,
"errorMessage": "API key authentication required"
}
}{
"success": false,
"code": 404,
"error": {
"errorCode": 404,
"errorMessage": "<string>"
}
}Authorizations
API key prefixed with sk_. Obtain from the Receiptor AI dashboard.
Body
Text query (used only when useSearch=true). Omit in filter-only mode.
Max documents to return
Sort field (docDate, amount, merchant, ...)
Sort order: 1 asc, -1 desc
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.
Show child attributes
Show child attributes
Enable semantic/text search
Search mode when useSearch=true: similarity (exact-ish) or mmr (broader)
similarity, mmr Export status filter
all, exported, not-exported Archive filter: exclude (default, active docs), only (archived docs), include (both).
exclude, only, include Response shape: compact (default) or complete
compact, complete Always include these extra fields (in addition to outputMode defaults)
Was this page helpful?