---
title: "List of variable instances"
method: GET
path: "/cmmn-runtime/variable-instances"
tags: ["History"]
---

# List of variable instances

`GET /cmmn-runtime/variable-instances`

## Request

- Base URL: `https://developer-docs.flowable.com/cmmn-api`
- URL: `https://developer-docs.flowable.com/cmmn-api/cmmn-runtime/variable-instances`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/docs/cmmn-runtime/variable-instances/get.ts> (a function with typed inputs; its response is checked against the schema)

For all 'Like' parameters the '%' wildcard character must be URL-encoded as '%25' (for example '?nameLike=acme%25' to match names starting with 'acme').

## Query parameters

- `caseInstanceId` string
- `taskId` string
- `excludeTaskVariables` boolean
- `excludeLocalVariables` boolean
- `variableName` string
- `variableNameLike` string
- `sort` 'caseInstanceId' | 'variableName'
- `order` string
- `start` integer
- `size` integer

## Response `200`

Indicates that variable instances could be queried.

- DataResponseVariableInstanceResponse
  - `data` VariableInstanceResponse[]
    - `id` string
    - `caseInstanceId` string
    - `caseInstanceUrl` string
    - `taskId` string
    - `planItemInstanceId` string
    - `variable` RestVariable
      - `name` string: Name of the variable
      - `type` string: Type of the variable.
      - `value` object: Value of the variable.
      - `valueUrl` string
      - `scope` string
  - `total` integer
  - `start` integer
  - `sort` string
  - `order` string
  - `size` integer

## Other responses

- `400`: Indicates an parameter was passed in the wrong format. The status-message contains additional information.

---

[API](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/revisions/afdfa1fcacd0?raw)