Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Workflows

Retrieve the Approval Requests on a Workflow

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

OAuth Scope required: public.workflows.readApprovals

get/workflows/{id}/approval-requests

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

Query parameters

pageinteger

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

pageSizeinteger

A limit of the number of results to return.

actorDetailsboolean

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

requestType'role' | 'user'

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

Headers

x-as-user-emailstring
Example:jane.doe@test.com

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-idstring
Example:5f0375c4cdc1927a3c5edcd3

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.

Response

200

pageinteger
pageSizeinteger
countinteger

Example response

{
  "pageSize": 20,
  "count": 42,
  "list": [
    {
      "startTime": "2024-12-20T20:23:41.335Z",
      "endTime": "2024-12-20T20:23:43.036Z",
      "status": "Approved",
      "actorId": "6334b636b9fb1eb6e76ada97",
      "actorType": "User",
      "actorDetails": {
        "userName": "Cave Johnson",
        "userEmail": "cave@aperturescience.com"
      },
      "role": "approver58348a760b354ab3a986f56a74656c86",
      "roleName": "CEO",
      "duration": 1701,
      "aggregateDuration": 1500,
      "approvalType": "Workflow"
    }
  ]
}