---
title: "List Realtime apps"
method: GET
path: "/v1/realtime/apps"
tags: ["realtime-apps"]
---

# List Realtime apps

`GET /v1/realtime/apps`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/realtime/apps`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns the workspace's Realtime apps as a paginated list, filterable by a case-insensitive `name` substring. Each entry carries the app's configuration and connection details (`app_id`, `region`) but never key secrets. Use [List a Realtime app's keys](/docs/api/reference/list-realtime-app-keys) and [Create a Realtime app key](/docs/api/reference/create-realtime-app-key) to manage them.

## Query parameters

- `name` string
- `sort` 'created_at' | 'name': Field to sort Realtime apps by.
- `order` 'asc' | 'desc': Sort direction, ascending or descending.
- `limit` integer
- `starting_after` string
- `ending_before` string
- `include_total` boolean

## Headers

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

## Response `200`

Paginated list of Realtime apps.

- RealtimeAppList
  - `data` RealtimeApp[], required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `client_events` boolean, required: Allow clients to trigger events directly (client events).
    - `connection_counting` boolean, required: Count the connections subscribed to each channel and expose the count on channel queries.
    - `connection_count_events` boolean, required: Broadcast connection-count events to public and private channel subscribers. Requires `connection_counting`. Presence channels do not emit these events; use a channel query to read their connection count.
    - `watchlist_events` boolean, required: Tell a signed-in member when the members on their watchlist come online or go offline. The watchlist is part of the identity your backend signs at signin.
    - `authorized_connections` boolean, required: Require every connection to be authorized.
    - `id` string, required
    - `app_id` integer, required: The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
    - `name` string, required: A label for the app, shown wherever it is listed.
    - `region` 'us1' | 'eu1', required: Deployment region identifier.
    - `status` 'active' | 'suspended', required: Lifecycle state of the app. `active` apps serve connections; `suspended` apps are provisioned but reject connections.
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.
  - `total` integer, nullable: Total number of items matching the request's filters across all pages. Present only when `include_total=true` was passed; otherwise `null`.

## 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/6dfce1179799?raw)