List a project's channels

channels(projectReference: ID!): ChannelList!

Requires project.channels.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject UUID or slug.

Response

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

FieldTypeDescription
data[Channel!]!All project channels, newest first by creation time then ID. This complete list is not paginated.

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

Example

graphql
query Channels($projectReference: ID!) {
  channels(projectReference: $projectReference) {
    data {
      id
      projectId
      agentId
      name
      status
    }
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}