---
title: "List Realtime channels"
method: GET
path: "/v1/realtime/apps/{realtime_app_id}/channels"
tags: ["realtime-events"]
---

# List Realtime channels

`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`

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

## Query parameters

- `prefix` string
- `include` RealtimeChannelInclude[]

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

The occupied channels.

- RealtimeChannelsList: The app's occupied channels. The Realtime service does not paginate this listing, so all occupied channels are returned in one response.
  - `data` RealtimeChannelListItem[], required: The occupied channels, sorted by name.
    - `member_count` integer: Distinct members (presence channels only; requires `include=member_count`).
    - `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.
    - `name` string, required: A Realtime channel name. Only letters, digits, and _ - = @ , . ; Prefix with `private-` or `presence-` for authenticated channels, or `private-encrypted-` for channels whose payloads are end-to-end encrypted with a key only you hold.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)