List Realtime channels
GET
/v1/realtime/apps/{realtime_app_id}/channels
curl -X GET "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/channels" \
-H "Authorization: Bearer $TOKEN"Lists the app's currently occupied channels, optionally filtered by name prefix.
Query Parameters
prefix
string
Only channels whose name starts with this prefix (e.g. "presence-").
include
array
Per-channel attributes to include. Repeatable. Requesting member_count without a presence-channel prefix, or connection_count when the app's connection-counting flag is off, returns a validation error (400).
Response Payload
data
array of object
required
The occupied channels, sorted by name.
Show child attributes
data.member_count
integer
Distinct members (presence channels only; requires include=member_count).
data.connection_count
integer
Connections currently subscribed to this channel (requires include=connection_count and the app's connection-counting flag). Channel-scoped — distinct from the app-wide peak connections metric.
data.name
string
required
A Realtime channel name. Only letters, digits, and _ - = @ , . ; Prefix with private- or presence- for authenticated channels.