---
title: "Get work definitions"
method: GET
path: "/work-definitions"
tags: ["Inspect", "Definitions"]
---

# Get work definitions

`GET /work-definitions`

## Request

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

## Query parameters

- `order` string
- `size` integer
- `sort` string
- `start` integer
- `type` string

## Response `200`

Indicates the definitions were found and returned.

- DataResponseWorkDefinitionRepresentation
  - `data` WorkDefinitionRepresentation[]
    - `id` string, required: The unique id
    - `key` string, required: The key of the definition
    - `version` integer, required: The version of the definition
    - `name` string: Definition name
    - `category` string: Definition category
    - `description` string: Definition description
    - `type` string, required: Definition type
    - `appName` string: App name
    - `appKey` string: App key
    - `appIcon` string: App icon
    - `appOrder` integer: App order
    - `appColor` string: App color
    - `translations` object: The translations for the work definition. Map having locale as the key and key value pairs for each locale.
    - `appTranslations` object: The translations for the app definition. Map having locale as the key and key value pairs for each locale.
  - `total` integer
  - `start` integer
  - `sort` string
  - `order` string
  - `size` integer

---

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