IRironcladapp
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

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/approvals
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.workflows.readApprovals

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. 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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. 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"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.