List Approval Requests

Returns a paginated list of the team's approval requests.

Results are scoped to the team that owns the API token. Draft and under-moderation requests are excluded.

Filtering:

  • status: one or more statuses, comma-separated (e.g. pending,approved)
  • priority: one or more priorities, comma-separated (e.g. high,critical)
  • workflow_slug: one or more workflow slugs, comma-separated
  • start_date / end_date: filter by creation date range (ISO 8601)
  • completed_at_start_date / completed_at_end_date: filter by completion date range
  • search: substring match on approval request number or workflow slug

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

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

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

string

Filter by priority level(s), comma-separated. Options: low, medium, high, critical.

string

Filter by workflow slug(s), comma-separated.

date-time

Return requests created on or after this datetime (ISO 8601).

date-time

Return requests created on or before this datetime (ISO 8601).

date-time

Return requests completed on or after this datetime (ISO 8601).

date-time

Return requests completed on or before this datetime (ISO 8601).

string

Substring match on approval request number or workflow slug.

string

Sort field: created_at, completed_at, priority, status. Prefix with '-' for descending. Default: -created_at.

integer

Page number for pagination.

integer

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

string

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

Responses

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