Skip to main content
GET
Get Channel by ID

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The Channel

A channel provides real-time messaging and communication within the platform.

changeSequence
integer<int32>

Optimistic locking version number.

channelType
object | null
channelTypeId
string | null
createdOn
string<date-time>

Timestamp when the channel was created.

id
string

Unique identifier (UUID) for the channel.

isPrivate
boolean
kapEnabled
boolean
name
string

Display name of the channel.

project
object | null

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

projectId
string | null
suppressEvents
boolean
task
object | null

A task represents a unit of work in a document review workflow, with an assignee, status, and due date.

taskId
string | null
updatedOn
string<date-time>

Timestamp when the channel was last updated.

uuid
string

Secondary UUID identifier.