---
title: "Get action instance"
method: GET
path: "/action-runtime/action-instances/{actionInstanceId}"
tags: ["Action Instances"]
---

# Get action instance

`GET /action-runtime/action-instances/{actionInstanceId}`

## Request

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

## Path parameters

- `actionInstanceId` string, required

## Response `200`

Indicates the action instance was found and returned.

- ActionInstanceResponse: Response for a runtime action instance
  - `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.

## Other responses

- `403`: Indicates the user does not have access to the requested action instance.
- `404`: Indicates the requested action instance was not found.

---

[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)