List human tasks
GET /v1/human-tasks
| Property | Value |
|---|---|
| Operation | list_human_tasks |
| Group | Human tasks |
| Scope | processes:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: Identifiers, statuses and the form; no title or field. |
| Released in | 1.62.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Lists the human tasks of the environment of the credential, newest first, with optional filters by status, instance and role queue, and the calling Member's own inbox with assigned_to_me=true (1.62.0). No title or field: a list holds no content.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the processes:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/human-tasks" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/human-tasks`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/human-tasks",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | no | The page size, 1 to 100. |
cursor | query | string | no | The opaque next_cursor of the previous page; it binds the filters it was issued under. |
status | query | HumanTaskStatus | no | Only the tasks in this status. |
process_id | query | ProcessInstanceId | no | Only the tasks of this instance. |
role_queue | query | WorkflowName | no | Only the tasks of this role queue. |
assigned_to_me | query | one of "true", "false" | no | true lists only the tasks the calling Member may claim or holds; an API key lists none with it. false, the default, lists every task. |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | HumanTaskList | |
400 | application/json | ErrorEnvelope | invalid_request, invalid_cursor |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is HumanTaskList.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of HumanTask | yes | The human tasks of this page, newest first. |
has_more | boolean | yes | True when a further page exists. |
next_cursor | string or null | yes | The cursor of the next page, or null on the last page. |
object | "list" | yes |