PRprocess
Tasks

Get a task

Returns a task in a workflow run by its ID.

get/workflow-runs/{workflowRunId}/tasks/{taskId}

Request

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

Path parameters

workflowRunIdstring required

The ID of the Workflow Run

taskIdstring required

The ID of the Task

Response

idstring required

The ID of the Task

updatedDatestring date-time required

When the resource was last modified. ISO-8601 UTC.

completedDatestring date-time
workflowRunIdstring required

The ID of the Workflow Run

status'NotCompleted' | 'Completed' required
dueDatestring date-time

Due date. ISO-8601 UTC.

namestring required

Display name.

hiddenboolean required

Whether the task is hidden by Conditional Logic.

stoppedboolean required

Whether the task is blocked (stopped) by an incomplete prior stop task.

Example response

{
  "id": "pBA0tRVntuwBoZxtgMx8KA",
  "updatedBy": {
    "id": "paiZa0_oyxEBoZxtatp33g",
    "email": "jane.doe@example.com",
    "username": "Jane Doe"
  },
  "completedBy": {
    "id": "paiZa0_oyxEBoZxtatp33g",
    "email": "jane.doe@example.com",
    "username": "Jane Doe"
  },
  "workflowRunId": "pBA0tRVntuwBoZxtgMx8KA",
  "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.