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

const axios = require('axios');

const url = 'https://api.fireflies.ai/graphql';
const headers = {
  'Content-Type': 'application/json',
  Authorization: 'Bearer your_api_key'
};

const data = {
  query: 'query Channel($channelId: ID!) { channel(id: $channelId) { id title is_private members { user_id email } } }',
  variables: { channelId: 'your_channel_id' }
};

axios
  .post(url, data, { headers: headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

import requests

url = 'https://api.fireflies.ai/graphql'
headers = {
    'Content-Type': 'application/json',
    '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"}}'

response = requests.post(url, headers=headers, data=data)
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpRequest.BodyPublishers;

public class ApiRequest {
    public static void main(String[] args) {
        HttpClient client = HttpClient.newHttpClient();
        String jsonRequest = "{\"query\": \"query Channel($channelId: ID!) { channel(id: $channelId) { id title is_private members { user_id email } } }\", \"variables\": {\"channelId\": \"your_channel_id\"}}";
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.fireflies.ai/graphql"))
            .header("Content-Type", "application/json")
            .header("Authorization", "Bearer your_api_key")
            .POST(BodyPublishers.ofString(jsonRequest))
            .build();

        client.sendAsync(request, HttpResponse.BodyHandlers.ofString())
            .thenApply(HttpResponse::body)
            .thenAccept(System.out::println)
            .join();
    }
}


{
  "data": {
    "channel": {
      "id": "channel-id-1",
      "title": "Engineering",
      "is_private": false,
      "members": [
        {
          "user_id": "user-id-1",
          "email": "john@example.com",
          "name": "John Doe"
        },
        {
          "user_id": "user-id-2",
          "email": "jane@example.com",
          "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

Channels

Query list of channels

Channel Schema

Schema for Channel