List workflow tasks

Lists all tasks of a workflow.

Results are sorted by time, with the most recently started first.

Request syntax

GET /workflows/${WORKFLOW_ID}/tasks?next=${NEXT_PAGE_CURSOR}&size=${PAGE_SIZE} HTTP/1.1
Host: api.simworkflow.com
Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}

Request headers

Authorization	`Bearer ${PERSONAL_ACCESS_TOKEN}`

URI request parameters

next	If `next` field is returned, there are more results available. The value of `next` is a unique pagination token for each page. Required: No
size	The maximum number of items to return per call. You can use `next` field to obtain further pages of results. The default is 100 and the allowed page sizes are: 5, 10, 25, 50, 100, 1000. Required: No

Required: No

size

The maximum number of items to return per call. You can use next field to obtain further pages of results. The default is 100 and the allowed page sizes are: 5, 10, 25, 50, 100, 1000.

Required: No

Response syntax

HTTP/1.1 200 OK
{
  "content": [
    {
    "id": String,
    "workflowId": String,
    "organizationId": String,
    "workflowDefinitionId": String,
    "workflowDefinitionVersion": Integer,
    "taskName": String,
    "status": String,
    "createdOn": Timestamp,
    "modifiedOn": Timestamp
    }
  ],
  "next": String
}

Response elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Field	Type	Description
`content`	Array[JSON Object]	Array of workflow tasks.
`next`	String	The next list requests to SimWorkflow can be continued with this `next`. `next` is obfuscated and is not a real key.

Errors

cURL example: get all workflow tasks

GET /workflows/23bBE1NGSll5narSt8NLsy/tasks

curl \
--request "GET" \
--header "Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}" \
--url "https://api.simworkflow.com/workflows/23bBE1NGSll5narSt8NLsy/tasks"

RESPONSE

HTTP/1.1 200 OK
{
  "content": [
    {
      "id": "39K2z9FLqulkggtQRisYlw",
      "workflowId": "23bBE1NGSll5narSt8NLsy",
      "organizationId": "0y4OfYajRyqc2RNueODHww",
      "workflowDefinitionId": "7RXzkCER4ERYGpMzvrfy1D",
      "workflowDefinitionVersion": 2,
      "taskName": "Issue",
      "status": "InProgress",
      "createdOn": "2023-11-10T02:26:30.301Z",
      "modifiedOn": "2023-11-10T02:32:48.835Z"
    }
  ],
  "next": null
}

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy