---
title: "Query action instances"
method: GET
path: "/action-runtime/action-instances"
tags: ["Action Instances"]
---

# Query action instances

`GET /action-runtime/action-instances`

## Request

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

## Query parameters

- `id` string
- `ids` string
- `name` string
- `nameLike` string
- `actionDefinitionId` string
- `actionDefinitionIdLike` string
- `formKey` string
- `formInstanceId` string
- `scopeId` string
- `subScopeId` string
- `scopeType` string
- `scopeDefinitionId` string
- `participantUser` string
- `participantUsers` string
- `participantGroup` string
- `participantGroups` string
- `supportsChannel` string
- `supportsChannels` string
- `startDate` unknown
- `startDateBefore` unknown
- `startDateAfter` unknown
- `tenantId` string
- `tenantIdLike` string
- `withoutTenantId` boolean
- `sort` 'startDate' | 'tenantId'

## Response `200`

successful operation

- DataResponseActionInstanceResponse
  - `data` ActionInstanceResponse[]
    - `id` string, required: The unique identifier for the action instance.
    - `name` string, required: The name for the action instance.
    - `actionDefinitionId` string, required: The id of the action definition for this action instance.
    - `scopeDefinitionId` string: The optional definition id for the scoped object.
    - `scopeId` string: The optional id of the scope that is linked with this action instance. If this property is set then scopeType is also set.
    - `scopeType` string: The optional type of the scope that is linked with this action instance. If this property is set then scopeId is also set.
    - `startDate` string, required: The starting date of the action instance in ISO 8601 format.
    - `formKey` string: The key of the form linked with this action instance.
    - `formParentDeploymentId` string: The parent deployment id of the form linked with this action instance. If not set it means newest form.
    - `formInstanceId` string: The id of the form instance linked with this action instance.
    - `priority` integer: The optional priority of the action, which can be used for sorting the actions
    - `tenantId` string: The id of the tenant that this action instance belongs to.
  - `total` integer
  - `start` integer
  - `sort` string
  - `order` string
  - `size` integer

---

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