GET /api/v2/approval_requests
Lists all approval requests for the current account with optional filtering by status and assignee.
Allowed For
- Admins
Query Parameters
| Name | Type | Description |
|---|---|---|
| filter[status] | string | Filter by a comma-separated list of one or more approval statuses. Values: active, approved, rejected, withdrawn |
| filter[assignee_user_id] | string | Filter by a comma-separated list of assigned user ids. Maximum 100 ids |
| filter[assignee_group_id] | string | Filter by a comma-separated list of assigned group ids. Maximum 100 ids |
Filtering Logic
- When multiple values are provided for a filter,
orlogic is used. For example,filter[status]=active,approvedis evaluated asstatus=active OR status=approved. - If multiple filters are applied to a single request,
ANDlogic is used. For example,filter[status]=active AND filter[assignee_user_id]=123. - Each filter parameter supports a maximum 100 values.
- Numeric ids must be valid integers.
Pagination
This endpoint supports cursor-based pagination. Use after_cursor and before_cursor parameters to navigate through results.
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter[assignee_group_id] |
String | No |
Filter by a comma-separated list of assigned group ids. Maximum 100 ids. |
filter[status] |
String | No |
Filter by a comma-separated list of one or more approval statuses. Allowed values are active, approved, rejected, withdrawn. Maximum 100 values. |
before_cursor |
String | No |
Cursor for pagination. Fetch records before this cursor |
filter[assignee_user_id] |
String | No |
Filter by a comma-separated list of assigned user ids. Maximum 100 ids. |
after_cursor |
String | No |
Cursor for pagination. Fetch records after this cursor |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.