---
title: "Get action definition"
method: GET
path: "/action-repository/action-definitions/{actionDefinitionId}"
tags: ["Action Definitions"]
---

# Get action definition

`GET /action-repository/action-definitions/{actionDefinitionId}`

## Request

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

## Path parameters

- `actionDefinitionId` string, required

## Query parameters

- `scopeId` string
- `scopeType` string
- `formId` string
- `formFieldId` string

## Response `200`

Indicates the action definition was found and returned.

- ActionDefinitionResponse: The response for an action definition
  - `id` string, required: The unique identifier of an action definition
  - `name` string: The name of the action definition
  - `key` string, required: The key of the action definition
  - `version` integer, required: The version of the action definition
  - `deploymentId` string: The deployment id of the action definition
  - `tenantId` string: The tenant id of the action definition
  - `resourceName` string: The resource name of the action definition
  - `description` string: The description of the action definition
  - `formKey` string: The form key for the action definition
  - `scopeType` string: The optional scope type for the action definition
  - `scopeId` string: The optional scope id for the action definition
  - `confirmationMessage` string: The confirmation message for the action definition
  - `confirmationTitle` string: The confirmation title for the action definition
  - `theme` string: The theme for the action definition
  - `icon` string: The icon for the action definition
  - `sample` string: A sample how this action definition can be used
  - `help` string: Help text for the action definition
  - `botKey` string: The key for the bot, if this action definition has a bot
  - `global` boolean, required: Flag indicating whether this action definition is a global one
  - `priority` integer: The optional priority of the action, which can be used for sorting the actions
  - `groupId` string: The optional grouping id for the action
  - `actionInstanceId` string: The id of the action instance (if this action definition is actually an action instance)
  - `startDate` string: The start date in ISO 8601 for the action instance (if this action definition is actually an action instance)
  - `formInstanceId` string: The id of the form instance for the action instance (if this action definition is actually an action instance)
  - `translations` object: The translations for the action instance. Map having locale as the key and key value pairs for each locale.

## Other responses

- `403`: Indicates the user does not have the rights to query for the action definition.
- `404`: Indicates the requested action definition 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)