List slack channels

slackChannels(input: SlackChannelsInput!): SlackChannelList!

Requires project.channels.read.

Arguments

ArgumentTypeRequired
inputSlackChannelsInput!Yes

Input fields

input

SlackChannelsInput

FieldTypeRequiredDescription
projectReferenceString!YesProject ID or slug. Requires a person's credential; agent, run, and service-account callers are forbidden.
queryStringNoName filter applied after fetching public and private channels.
limitIntNoFetch up to this many public and this many private channels before query filtering. Range 1..200; omit/null defaults to 100.

Response

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

FieldTypeDescription
data[SlackChannel!]!Channels visible to the connected Slack workspace. A missing connection or missing scopes that leave no accessible channels fails with validation-failed; other Slack HTTP or provider failures use external-service-error.

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

Example

graphql
query SlackChannels($input: SlackChannelsInput!) {
  slackChannels(input: $input) {
    data {
      id
      name
      isArchived
      isPrivate
    }
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}