Skip to main content
POST
/
v1
/
receipts
/
search
Search receipts
curl --request POST \
  --url https://api.truthlocks.com/v1/receipts/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "subject": "<string>",
  "receipt_type": "<string>",
  "status": "<string>",
  "from": "<string>",
  "to": "<string>",
  "limit": 20
}
'
{
  "items": [
    {}
  ],
  "total": 123
}
Search receipts using full-text search and faceted filters. Combine a text query with structured filters to narrow results.

​
Request

​
q
string
Full-text search across payload content.
​
receipt_type
string
Filter by receipt type name (e.g. payment_receipt).
​
status
string
Filter by status: active, revoked, superseded, or redacted.
​
issuer_id
string
Filter by issuer UUID.
​
from_date
string
Start of date range (RFC 3339).
​
to_date
string
End of date range (RFC 3339).
​
index_key
string
Search by indexed payload field name.
​
index_value
string
Value to match for index_key.
​
limit
integer
Max results per page (1–100, default 20).
​
offset
integer
Pagination offset (default 0).

​
Response

​
items
array
Array of matching receipt objects.
​
total
integer
Total number of matching receipts.
​
limit
integer
Page size used.
​
offset
integer
Current offset.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
​
subject
string
​
receipt_type
string
​
status
string
​
from
string

ISO 8601 start date

​
to
string

ISO 8601 end date

​
limit
integer
default:20

Response

Search results

​
items
object[]
​
total
integer