---
title: "Get channel definitions"
method: GET
path: "/event-registry/channel-definitions"
tags: ["Inspect", "Event Registry"]
---

# Get channel definitions

`GET /event-registry/channel-definitions`

## Request

- Base URL: `http://localhost:8090/inspect-api`
- URL: `http://localhost:8090/inspect-api/event-registry/channel-definitions`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-inspect-rest-api/docs/event-registry/channel-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, required

## Response `200`

Indicates the definitions were found and returned.

- DataResponseChannelDefinitionResponse
  - `data` ChannelDefinitionResponse[]
    - `id` string
    - `url` string
    - `key` string
    - `version` integer
    - `name` string
    - `type` 'inbound' | 'outbound'
    - `implementation` string
    - `createTime` string, date-time
    - `description` string
    - `tenantId` string
    - `deploymentId` string
    - `deploymentUrl` string
    - `resourceName` string
    - `resource` string: Contains the actual deployed channel definition JSON.
    - `category` string
  - `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)
