v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

List All Workflow Approvals

Returns a list of approvals for the workflow. The approvalGroups property will display only triggered approvals (i.e. conditional approvals that have not been triggered will not appear).

OAuth Scope required: public.workflows.readApprovals

get/workflows/{id}/approvals

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

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

workflowIdstring

titlestring

Example response

{
  "workflowId": "5f595f76c4fc9b3571413c3ac",
  "title": "Consulting Agreement with Michael Scott Paper Company",
  "approvalGroups": [
    {
      "reviewers": [
        {
          "role": "finance",
          "displayName": "Finance",
          "reviewerType": "role",
          "status": "pending"
        }
      ],
      "status": "pending",
      "order": 1
    }
  ],
  "roles": [
    {
      "id": "legal",
      "displayName": "Legal",
      "assignees": [
        {
          "userName": "Boba Fett",
          "userId": "63d415e0dd0d828c3a878548",
          "email": "bobafett@exmaple.com"
        }
      ]
    }
  ]
}