chatChannels

Requires an authenticated session.

Lists the team chat channels the caller can see, with their members. Needs a signed-in user.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ChatChannels {
  chatChannels {
    id
    name
    createdAt
    createdBy
    description
    isDefault
    conversation {
      id
      title
      type
      createdAt
      channelId
      isGroup
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ChatChannels {\n  chatChannels {\n    id\n    name\n    createdAt\n    createdBy\n    description\n    isDefault\n    conversation {\n      id\n      title\n      type\n      createdAt\n      channelId\n      isGroup\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "chatChannels": [
      {
        "id": "id",
        "name": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "createdBy": "string",
        "description": "string",
        "isDefault": true,
        "conversation": {
          "id": "id",
          "title": "string",
          "type": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "channelId": "string",
          "isGroup": true
        }
      }
    ]
  }
}

chatChannels: [ChatChannel!]!

Type

ChatChannel object

A chat channel that people can join.