Stream Chat icon

Stream Chat

Server-side Stream Chat operations

Channel → Show

AI-generated

Summary

Retrieve detailed information about a specific Stream Chat channel, including its properties and current state.

Inputs

  • Channel Type — Specify the channel type such as "messaging" for direct chats, "team" for group channels, or "livestream" for broadcast channels. Defaults to "messaging".
  • Channel ID (required) — Provide the unique identifier of the channel (e.g., "general", "random", "team-alpha"). Combined with the channel type to form the channel CID.
  • User ID — Optionally specify a User ID for server-side operations related to showing the channel (e.g., permissions or visibility context).

Output shape

a single JSON object containing the channel details as returned by the Stream Chat server-side API, including channel properties, membership, and state.

If a User ID is specified, the returned channel data may reflect user-specific visibility or state. The operation queries the channel synchronously and returns one channel object.

Examples

Example 1: Show details of the 'general' messaging channel

Set Channel Type to 'messaging' and Channel ID to 'general'.

Example 2: Show details of a team channel 'team-alpha' with a user context

Set Channel Type to 'team', Channel ID to 'team-alpha', and User ID to the relevant user's ID.

Discussion