Read one channel and its runtime target

channel(projectReference: ID!, channelId: ID!): Channel!

Requires project.channels.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject UUID or slug.
channelIdID!YesChannel ID in the selected project; a channel in another project returns not_found.

Response

Returns Channel!. Open the type for its fields and nested types.

FieldTypeDescription
idID!
projectIdID!
platformChannelPlatform!
nameString
agentIdStringProject agent that answers in this channel.
enabledBoolean!Always true today; kept for forward compatibility.
statusChannelStatus!
installationIdID

All fields of Channel.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query Channel($projectReference: ID!, $channelId: ID!) {
  channel(projectReference: $projectReference, channelId: $channelId) {
    id
    projectId
    agentId
    name
    status
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "channelId": "00000000-0000-4000-8000-000000000001"
}