---
title: "Get channel definition by key"
method: GET
path: "/event-registry/channel-definitions/key/{key}/model"
tags: ["Inspect", "Event Registry"]
---

# Get channel definition by key

`GET /event-registry/channel-definitions/key/{key}/model`

## Request

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

## Path parameters

- `key` string, required

## Response `200`

Indicates the definition was found and returned.

- ChannelModel
  - `key` string
  - `category` string
  - `name` string
  - `description` string
  - `channelType` string
  - `type` string
  - `extension` JsonNode
    - `string` boolean
    - `valueNode` boolean
    - `missingNode` boolean
    - `short` boolean
    - `double` boolean
    - `bigDecimal` boolean
    - `bigInteger` boolean
    - `textual` boolean
    - `boolean` boolean
    - `container` boolean
    - `object` boolean
    - `binary` boolean
    - `number` boolean
    - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
    - `long` boolean
    - `pojo` boolean
    - `int` boolean
    - `integralNumber` boolean
    - `floatingPointNumber` boolean
    - `array` boolean
    - `empty` boolean
    - boolean
    - `float` boolean
    - `embeddedValue` boolean

---

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