Retrieve the Approval Requests on a Workflow

get

https://na1.ironcladapp.com/public/api/v1/workflows/{id}/approval-requests

Returns a list of approval requests that have taken place on the workflow.

OAuth Scope required: public.workflows.readApprovals

Path Params

string

required

The unique identifier or Ironclad ID of a workflow.

Query Params

page

int32

0 to 100000000

Defaults to 0

The page number used when paginating through a list of results.

pageSize

int32

1 to 100

Defaults to 20

A limit of the number of results to return.

actorDetails

boolean

Defaults to false

An optional boolean parameter that adds additional information about the actor to each item in the response. Defaults to false.

requestType

string

enum

Defaults to user

An optional string parameter that specifies the type of approval requests and returns approval requests by role or user.

Allowed:

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Language

Credentials

URL

Response

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

application/json

200200

403403

404404