Overview

Introduction

Tasklist API is a REST API and provides searching, getting, and changing Tasklist data. Requests and responses are in JSON notation. Some objects have additional endpoints.

Context paths

For SaaS: https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/v1/, and for Self-Managed installations: http://localhost:8080/v1/.

note

Find your region and cluster id under Connection information in your client credentials (revealed when you click on your client under the API tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Tasklist component.

API documentation as Swagger

A detailed API description is also available as Swagger UI at https://${base-url}/swagger-ui/index.html.

For SaaS: https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/swagger-ui/index.html, and for Self-Managed installations: http://localhost:8080/swagger-ui/index.html.

note

Find your region and cluster id under Connection information in your client credentials (revealed when you click on your client under the API tab within your cluster).

Endpoints

Endpoint (HTTP verb + URL path)	Description
Tasks
GET /v1/tasks/{taskId}	Return a task by taskId.
POST /v1/tasks/search	Returns the list of tasks that satisfy search request params.
POST /v1/tasks/{taskId}/variables/search	Returns a list of task variables for the specified taskId and variableNames.
PATCH /v1/tasks/{taskId}/assign	Assign a task with taskId to assignee or the active user.
PATCH /v1/tasks/{taskId}/unassign	Unassign a task with provided taskId.
PATCH /v1/tasks/{taskId}/complete	Complete a task with taskId and optional variables.
Forms
GET /v1/forms/{formId}?processDefinitionKey={processDefinitionKey}	Get the form details by formId and processDefinitionKey required query param.
Variables
GET /v1/variables/{variableId}	Get the variable details by variableId.