---
title: "List of plan item instances"
method: GET
path: "/cmmn-runtime/plan-item-instances"
tags: ["Plan Item Instances"]
---

# List of plan item instances

`GET /cmmn-runtime/plan-item-instances`

## Request

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

## Query parameters

- `id` string
- `caseDefinitionId` string
- `caseInstanceId` string
- `caseInstanceIds` string
- `stageInstanceId` string
- `planItemDefinitionId` string
- `planItemDefinitionType` string
- `planItemDefinitionTypes` string
- `state` string
- `name` string
- `elementId` string
- `referenceId` string
- `referenceType` string
- `createdBefore` unknown
- `createdAfter` unknown
- `startUserId` string
- `includeEnded` boolean
- `includeLocalVariables` boolean
- `tenantId` string
- `withoutTenantId` boolean
- `sort` 'name' | 'createTime' | 'startTime'

## Response `200`

Indicates request was successful and the executions are returned

- DataResponsePlanItemInstanceResponse
  - `data` PlanItemInstanceResponse[]
    - `id` string
    - `url` string
    - `name` string
    - `caseInstanceId` string
    - `caseInstanceUrl` string
    - `caseDefinitionId` string
    - `caseDefinitionUrl` string
    - `derivedCaseDefinitionId` string
    - `derivedCaseDefinitionUrl` string
    - `stageInstanceId` string
    - `stageInstanceUrl` string
    - `planItemDefinitionId` string
    - `planItemDefinitionType` string
    - `state` string
    - `stage` boolean
    - `elementId` string
    - `createTime` string, date-time
    - `lastAvailableTime` string, date-time
    - `lastEnabledTime` string, date-time
    - `lastDisabledTime` string, date-time
    - `lastStartedTime` string, date-time
    - `lastSuspendedTime` string, date-time
    - `completedTime` string, date-time
    - `occurredTime` string, date-time
    - `terminatedTime` string, date-time
    - `exitTime` string, date-time
    - `endedTime` string, date-time
    - `startUserId` string
    - `assignee` string
    - `completedBy` string
    - `referenceId` string
    - `referenceType` string
    - `completable` boolean
    - `entryCriterionId` string
    - `exitCriterionId` string
    - `formKey` string
    - `extraValue` string
    - `tenantId` string
    - `localVariables` 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 a 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)