Delivery

Filter documents with structured conditions

Query documents using an ordered list of filter conditions against materialised field values. Optional free-text search applies alongside the structured filter. limit is clamped to a server-side maximum of 500.

post/v1/documents/filter

Request

  • Base URL: https://api.talonic.com
  • URL: https://api.talonic.com/v1/documents/filter
  • Auth: HTTP bearer

Request body

source_idstring uuid

Optional source connection UUID to narrow the result set.

searchstring

Optional free-text search applied alongside the structured conditions.

pageinteger

1-based page number. Default 1.

limitinteger

Page size. Server clamps to a maximum of 500. Default 50.

Example request

{
  "source_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "conditions": [
    {
      "fieldId": "amount",
      "operator": "between"
    }
  ]
}

Response

Matching documents with a total count.

dataobject[] required

Matching document rows.

totalinteger required

Total number of matching documents.

Example response

{
  "total": 142
}

Changes

No recorded changes to this operation across all 1 revision of this API.