Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Workflow Widgets

List widgets

Returns widgets for a task on a workflow revision, ordered by position.

get/workflows/{workflowId}/revisions/{revisionId}/tasks/{taskId}/widgets

Path parameters

workflowIdstring required

The ID of the Workflow

revisionIdstring required

The ID of the Revision

taskIdstring required

The ID of the Task

Query parameters

type'CrossLink' | 'Email' | 'Embed' | 'File' | 'FormField' | 'Image' | 'Text' | 'Video'

Filter by widget type.

_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": "hUI7y6YGKMuZBMDLJc5Kdw",
      "taskId": "hUI7y6YGKMuZBMDLJc5Kdw",
      "createdBy": {
        "id": "naAJxoDIuwdgNsQHGRRGqA",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "updatedBy": {
        "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"
    }
  ]
}