Search variablesAdded in 8.8

POST 
/variables/search

Eventually Consistent About endpoint data consistency

Search for variables based on given criteria.

This endpoint returns variables that exist directly at the specified scopes - it does not include variables from parent scopes that would be visible through the scope hierarchy.

Variables can be process-level (scoped to the process instance) or local (scoped to specific BPMN elements like tasks, subprocesses, etc.).

By default, long variable values in the response are truncated.

Required permissions

When authorization is enabled, this endpoint requires the following permission. See resources and permissions to learn more.

Resource type	Permission
PROCESS_DEFINITION	READ_PROCESS_INSTANCE

Results you are not authorized to access are filtered from the response rather than rejected.

Request

Responses

200

The variable search result.

400

The provided data is not valid.

401

The request lacks valid authentication credentials.

Response Headers

WWW-Authenticate

403

Forbidden. The request is not allowed.

500

An internal error occurred while processing the request.