realtime-apps

Get a Realtime app

Returns a single Realtime app with its configuration and connection details (app_id, region). Key secrets are never included; use List a Realtime app's keys to manage them. Returns a 404 Not Found error if the app does not exist in the workspace.

get/v1/realtime/apps/{realtime_app_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

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

Realtime app with its current configuration and status.

created_atstring date-time required
updated_atstring date-time required
client_eventsboolean required

Allow clients to trigger events directly (client events).

connection_countingboolean required

Count the connections subscribed to each channel and expose the count on channel queries.

connection_count_eventsboolean 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_eventsboolean 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_connectionsboolean required

Require every connection to be authorized.

idstring required
app_idinteger required

The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.

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

Example response

{
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z",
  "id": "rap_01krdgeqcxet5s7t44vh8rt9mg",
  "app_id": 432557,
  "name": "chat-production",
  "region": "us1"
}

Changes

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