realtime-events

List Realtime channels

Lists the app's currently occupied channels, optionally filtered by name prefix.

get/v1/realtime/apps/{realtime_app_id}/channels

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/channels
  • Auth: one of:
    • HTTP bearer and API key in header X-Realtime-Key and API key in header X-Realtime-Secret
    • API key in cookie bird_session and API key in header X-Realtime-Key and API key in header X-Realtime-Secret

Query parameters

prefixstring

Only channels whose name starts with this prefix (for example, presence-).

includeRealtimeChannelInclude[]

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).

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The occupied channels.

Example response

{
  "data": [
    {
      "name": "orders-42"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.