List approval requests for an account

post

https://api.convert.com/api/v2/accounts/{account_id}/approval-requests

Returns approval requests within the account, filterable by entity_type, entity_id,
status, submitted_by, and requires_my_approval. Results are paginated (default page
size 25) and scoped to the requests the calling user is permitted to see. When onlyCount
is true, the response contains only the total count and omits the item data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the approval requests.

Body Params

Filtering, sorting, and pagination options for listing approval requests.

onlyCount

boolean

If set to true in a list request, the response will only contain the total count of matching items (extra.pagination.items_count)
and will not include the actual item data. Useful for quickly getting totals without fetching full datasets.

page

integer

≥ 1

The page number for paginated results. For example, if results_per_page is 30, page: 2 will retrieve items 31-60.
Defaults to 1 if not specified.

include

array of objects

Specifies the list of fields to be expanded in the response from a
user-id string into a { uid, name } object, which otherwise would
be returned as a plain string.

include

Allowed:

entity_type

array of objects

Filter by entity type. Provide multiple values to filter by any of them.

entity_type

Allowed:

entity_id

string

Filter by the ID of the entity being acted on.

status

array of objects

Filter by request status. Provide multiple values to filter by any of them.

status

Allowed:

submitted_by

string

Filter by the user ID of the submitter.

requires_my_approval

boolean

When true, returns only pending requests the calling user is eligible to approve.

results_per_page

integer

≥ 1

Defaults to 25

Number of items per page (default 25).

sort_by

string

enum

Defaults to submitted_at

The field to sort results by.

Allowed:

sort_direction

string

enum

Defaults to asc

The sort direction.

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A paginated list of approval requests the calling user is permitted to see.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.