---
title: "List case instances"
method: GET
path: "/cmmn-runtime/case-instances"
tags: ["Case Instances"]
---

# List case instances

`GET /cmmn-runtime/case-instances`

## Request

- Base URL: `https://developer-docs.flowable.com/cmmn-api`
- URL: `https://developer-docs.flowable.com/cmmn-api/cmmn-runtime/case-instances`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/docs/cmmn-runtime/case-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

- `id` string
- `ids` string
- `caseDefinitionKey` string
- `caseDefinitionKeyLike` string
- `caseDefinitionKeyLikeIgnoreCase` string
- `caseDefinitionId` string
- `caseDefinitionCategory` string
- `caseDefinitionCategoryLike` string
- `caseDefinitionCategoryLikeIgnoreCase` string
- `caseDefinitionName` string
- `caseDefinitionNameLike` string
- `caseDefinitionNameLikeIgnoreCase` string
- `name` string
- `nameLike` string
- `nameLikeIgnoreCase` string
- `rootScopeId` string
- `rootScopeIds` string
- `parentScopeId` string
- `parentScopeIds` string
- `businessKey` string
- `businessKeyLike` string
- `businessKeyLikeIgnoreCase` string
- `businessStatus` string
- `businessStatusLike` string
- `businessStatusLikeIgnoreCase` string
- `caseInstanceParentId` string
- `startedBy` string
- `startedBefore` string, date-time
- `startedAfter` string, date-time
- `state` string
- `callbackId` string
- `callbackIds` string
- `callbackType` string
- `parentCaseInstanceId` string
- `parentProcessInstanceId` string
- `referenceId` string
- `referenceType` string
- `lastReactivatedBy` string
- `lastReactivatedBefore` string, date-time
- `lastReactivatedAfter` string, date-time
- `includeCaseVariables` boolean
- `includeCaseVariablesName` string
- `activePlanItemDefinitionId` string
- `tenantId` string
- `tenantIdLike` string
- `tenantIdLikeIgnoreCase` string
- `withoutTenantId` boolean
- `sort` 'id' | 'caseDefinitionId' | 'tenantId' | 'caseDefinitionKey'

## Response `200`

Indicates request was successful and the case instances are returned

- DataResponseCaseInstanceResponse
  - `data` CaseInstanceResponse[]
    - `id` string
    - `name` string
    - `url` string
    - `businessKey` string
    - `businessStatus` string
    - `dueDate` string, date-time
    - `claimTime` string, date-time
    - `claimedBy` string
    - `startTime` string, date-time
    - `startUserId` string
    - `state` string
    - `ended` boolean
    - `caseDefinitionId` string
    - `caseDefinitionUrl` string
    - `caseDefinitionName` string
    - `caseDefinitionDescription` string
    - `parentId` string
    - `callbackId` string
    - `callbackType` string
    - `referenceId` string
    - `referenceType` string
    - `variables` RestVariable[]
      - `name` string: Name of the variable
      - `type` string: Type of the variable.
      - `value` object: Value of the variable.
      - `valueUrl` string
      - `scope` string
    - `tenantId` string
    - `completed` boolean
  - `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)