Get all approval requests

  • Published on Sep 3, 2025
  • 2 minute(s) read
Prev Next
Get
/v1/approval_requests

Get detailed information of all approval requests that the current user has access to.

Security
API Key: bearerToken
Header parameter nameAuthentication

A JWT bearer token to be passed once authenticated.

Query parameters
requester
string (uuid)

Only retrieve approval requests with the specified requester ID

reviewer
string (uuid)

Only retrieve approval requests with the specified reviewer ID

subject
string (uuid)

Only retrieve approval requests with the specified subject ID

status
string

Only retrieve approval requests with the specified approval status

Valid values[ "PENDING", "APPROVED", "DENIED", "FAILED" ]
all_search
string

Search on name or description.

sort_by
string

Sort fields. In the format of key1:ASC,key2:DESC,key3:DESC

limit
integer

Maximum numbers of app configs to return.

offset
integer

Number of app configs to skip from start.

filter
string

Filter items based on groups or labels.

Responses
200

Search result for approval request objects.

Expand All
object
metadata
object (SearchMetadata)
page
integer

Current page number

pages
integer

Total pages as per the item counts and page limit.

limit
integer

Number of items to limit in a page.

total_count
integer

Total number of unfiltered items.

filtered_count
integer

Total number of items as per the current filter.

items
Array of object (ApprovalRequest)
object
request_id
string (uuid)

UUID uniquely identifying this approval request.

requester
object (Entity)

An app, user, or plugin ID.

user
string (uuid)

The user ID of the user who created this entity, if this entity was created by a user.

created_at
integer (int64)

When this approval request was created.

acct_id
string (uuid)

The account ID of the account that this approval request belongs to.

group_id
string (uuid)

The group ID where this approval request belongs to.

operation
string

Operation URL path, e.g. /crypto/v1/keys, /crypto/v1/groups/<id>.

method
string

Method for the operation: POST, PATCH, PUT, DELETE, or GET. Default is POST.

body
object
approvers
Array of object (Entity)
object

An app, user, or plugin ID.

user
string (uuid)

The user ID of the user who created this entity, if this entity was created by a user.

denier
object (Entity)

An app, user, or plugin ID.

user
string (uuid)

The user ID of the user who created this entity, if this entity was created by a user.

denial_reason
string

Reason given by denier.

reviewers
Array of object (Entity)
object

An app, user, or plugin ID.

user
string (uuid)

The user ID of the user who created this entity, if this entity was created by a user.

status
string

Approval request status.

Valid values[ "PENDING", "APPROVED", "DENIED", "FAILED", "DENIED_OTHER", "PENDING_CHILD", "PENDING_OTHER" ]
subjects
Array of object (ApprovalSubject)
object

Identifies an object acted upon by an approval request.

workflow
string (uuid)

The ID of the workflow being acted upon.

description
string

Optional comment about the approval request for the reviewer.

expiry
integer (int64)

When this approval request expires.