Skip to main content

Overview

The channel query is designed to fetch details of a specific channel by its ID. The user must have access to the channel (either it’s a public channel in their team, or they are a member of the private channel).

Arguments

id
ID!
required
The unique identifier of the channel to fetch.

Schema

Fields available to the Channel query

Usage Example

query Channel($channelId: ID!) {
  channel(id: $channelId) {
    id
    title
    is_private
    created_by
    created_at
    updated_at
    members {
      user_id
      email
      name
    }
  }
}
curl -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer your_api_key" \
    --data '{ "query": "query Channel($channelId: ID!) { channel(id: $channelId) { id title is_private members { user_id email } } }", "variables": { "channelId": "your_channel_id" } }' \
    https://api.fireflies.ai/graphql
{
  "data": {
    "channel": {
      "id": "channel-id-1",
      "title": "Engineering",
      "is_private": false,
      "members": [
        {
          "user_id": "user-id-1",
          "email": "[email protected]",
          "name": "John Doe"
        },
        {
          "user_id": "user-id-2",
          "email": "[email protected]",
          "name": "Jane Smith"
        }
      ]
    }
  }
}

Error Codes

List of possible error codes that may be returned by the channel query. Full list of error codes can be found here.

The channel ID you are trying to query does not exist or you do not have access to it.

Additional Resources