Overview

note

Camunda introduced the Camunda 8 REST API with 8.6 to manage and query process entities such as processes, decisions, forms, and user tasks.

Camunda has also introduced Zeebe user tasks to build more advanced functionalities. If you use Zeebe user tasks with 8.6, task management endpoints in the Tasklist API will not work.

Introduction

The Tasklist API is a REST API designed to build task applications for human-centered processes. The API allows you to query user tasks, assign users to these tasks, and complete these tasks.

note

Ensure you authenticate before accessing the Tasklist API.

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 Explorer

See the interactive Tasklist REST API Explorer for specifications, example requests and responses, and code samples of interacting with the Tasklist REST API.

Swagger UI

A detailed API description is also available as a 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).

API in Postman

Work with this API in our Postman collection, and check it out in GitHub.