Search Approval Requests

Advanced filtering for AI/analytics use cases. Returns a paginated list of the team's approval requests matching the supplied metadata and workflow field-UID conditions (all combined with AND). Results are scoped to the team that owns the API token; draft and under-moderation requests are excluded.

Field-UID filters (filters) operate within a single workflow and require workflow_id. Each condition is {field_uid, operator, value}.

Finding the ids: list your workflows (with their id and slug) via GET /api/v1/workflows, then fetch a workflow's field_uids via GET /api/v1/workflows/{id}/fields (or /{slug}/fields).

Operators: equals, contains, starts_with, in (value = list), greater_than, less_than, date_between (value = [start, end]).

Metadata filters: workflow_id, status, priority, request_id, submitter (email), approver (email), created_at/updated_at ({start, end} ISO 8601 ranges).

Sorting: ordering accepts created_at, completed_at, priority, status (prefix - for descending). Defaults to -created_at.

Nested table fields (line items) are not searchable in v1.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Page number for pagination.

integer

Number of results per page (max 100, default 20).

string

Return all results without pagination (set to 'true').

Body Params
integer

Workflow to scope field filters to. Required when 'filters' is provided.

filters
array of objects

Field-UID conditions, combined with AND.

filters
string

Filter by status(es): a comma-separated string or JSON array. Options: pending, approved, rejected, canceled, change_requested, deferred, scheduled.

string

Filter by priority level(s): a comma-separated string or JSON array. Options: low, medium, high, critical.

string

Filter by approval request number(s): a comma-separated string or JSON array.

string
string
created_at
object
updated_at
object
string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json