---
title: "Get action definition form by key"
method: GET
path: "/action-repository/action-definitions/key/{actionDefinitionKey}/form-model"
tags: ["Action Definitions"]
---

# Get action definition form by key

`GET /action-repository/action-definitions/key/{actionDefinitionKey}/form-model`

## Request

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

## Path parameters

- `actionDefinitionKey` string, required

## Query parameters

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

## Response `200`

Indicates the form for action definition was found and returned.

- FormModel

## Other responses

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