Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Tasks

List all approvals in a workflow run

Returns a list of approved or rejected approvals for a workflow run. It will not return pending approvals that have not yet been acted upon. The approvals are returned 20 at a time, sorted in task order. You must use the links section to get the next 20 results.

get/workflow-runs/{workflowRunId}/approvals

Path parameters

workflowRunIdstring required

The ID of the Workflow Run

Query parameters

_string

Opaque pagination cursor. Take this value from the previous response's links[] entry whose name is "next" (typically just follow that link's href instead of reading this value). Omit on the first page. If the previous response had no next link, there are no more pages.

Response

Example response

{
  "approvals": [
    {
      "audit": {
        "createdBy": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        },
        "updatedBy": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        }
      },
      "reviewedBy": {
        "id": "naAJxoDIuwdgNsQHGRRGqA",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "links": [
        {
          "href": "https://api.process.st/api/v1.1/resource/XXX"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}