Overview
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.
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/
.
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][tasklist-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
.
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.