VocalDocscontracts 1.65.0

List human tasks

GET /v1/human-tasks

PropertyValue
Operationlist_human_tasks
GroupHuman tasks
Scopeprocesses:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: Identifiers, statuses and the form; no title or field.
Released in1.62.0
Phase 0 hostServed (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"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
statusqueryHumanTaskStatusnoOnly the tasks in this status.
process_idqueryProcessInstanceIdnoOnly the tasks of this instance.
role_queuequeryWorkflowNamenoOnly the tasks of this role queue.
assigned_to_mequeryone of "true", "false"notrue 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

StatusContent typeShapeError codes
200application/jsonHumanTaskList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is HumanTaskList.

FieldTypeRequiredDescription
dataarray of HumanTaskyesThe human tasks of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes