Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Get Config

AI-generated

Summary

Retrieve the configuration details of a specific Stream Chat channel by specifying its type and unique identifier.

Inputs

  • Channel Type — Specify the type of the channel, such as "messaging" for 1-on-1 chats, "team" for group channels, or "livestream" for broadcast channels. Defaults to "messaging".
  • Channel ID (required) — Enter the unique identifier for the channel (e.g., "general", "random", "team-alpha"). This combines with the Channel Type to form the channel's CID.

Output shape

a single JSON object containing the channel's configuration details

The returned configuration includes channel metadata as defined by the Stream Chat API. No pagination applies as this operation retrieves a singular resource.

Examples

Example 1: Retrieve configuration for a 'team' channel with ID 'team-alpha'

Set Channel Type to 'team' and Channel ID to 'team-alpha' to get its current configuration.

Discussion