Workflow Runs

List all workflow runs

Returns a paginated list of workflow runs accessible to the calling user, sorted by creation date (newest first). Soft-deleted runs are excluded; only runs of workflow-type templates are returned (runs of page-type templates are out of scope).

get/workflow-runs/list

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/workflow-runs/list
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

workflowIdstring

Filter results to runs of a specific workflow. If the workflow does not exist or is inaccessible, the response is an empty page rather than an error.

statusstring

Filter results by workflow run status.

  • Active — the run is in progress.
  • Completed — all tasks were completed and the run was finalised.
  • Archived — the run was archived from the active list.

The internal Deleted status is hidden from the public API surface and rejected here. Omit this filter to include all non-deleted runs.

_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

{
  "data": [
    {
      "id": "ghmmGB8wvb0BoZxtb5ByfQ",
      "workflowId": "ghmmGB8wvb0BoZxtb5ByfQ",
      "links": [
        {
          "href": "https://api.process.st/api/v1.1/resource/XXX"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

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