PRprocess
Workflow Runs

Get a workflow run

Returns a workflow run by its ID.

get/workflow-runs/{workflowRunId}

Request

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

Path parameters

workflowRunIdstring required

The ID of the Workflow Run

Response

idstring required

The ID of the Workflow Run

namestring

Display name.

status'Active' | 'Completed' | 'Archived' | 'Deleted' required

Lifecycle status of a workflow run.

  • 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 (no further task progress is recorded but the run stays queryable).
  • Deleted — the run was soft-deleted.

List endpoints return only Active runs unless otherwise indicated.

workflowIdstring required

The ID of the Workflow

sharedboolean required
dueDatestring date-time

Due date. ISO-8601 UTC.

migrationStatus'Inactive' | 'Scheduled' | 'Migrating' required

Whether this run is currently being migrated to a newer workflow revision.

  • Inactive — not in a migration; this is the normal state.
  • Scheduled — a migration to a newer revision has been requested and is queued.
  • Migrating — migration is in progress; some fields may change shortly.

Example response

{
  "id": "l2MIiSPpvfABoZxteqZ4Ew",
  "workflowId": "l2MIiSPpvfABoZxteqZ4Ew",
  "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.