List Realtime apps
GET
/v1/realtime/apps
curl -X GET "https://us1.platform.bird.com/v1/realtime/apps" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25" \
--url-query "include_total=false"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; manage keys with listRealtimeAppKeys and createRealtimeAppKey.
查询参数
name
string
Substring match against the app name (case-insensitive).
sort
string
Field to sort by.
Possible values: created_at, name
order
string
Sort direction. Defaults to desc (newest/largest first).
Possible values: asc, desc
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
include_total
boolean
When true, the response includes a total field with the total number of items matching the request's filters across all pages.
响应载荷
data
array of object
必填
显示子属性
data.created_at
string
必填
data.updated_at
string
必填
data.client_events
boolean
必填
Allow clients to trigger events directly (client events).
data.connection_counting
boolean
必填
Emit connection-count events on channels.
data.authorized_connections
boolean
必填
Require every connection to be authorized.
data.id
string
必填
data.app_id
integer
必填
The numeric Realtime app id. Use it together with a key and secret to initialize a Realtime client/server SDK. Immutable.
data.name
string
必填
data.region
object
必填
The region this app runs in. Unlike other Bird products, a Realtime app can be placed in a region other than the workspace's home region. Immutable after creation.
data.status
string
必填
Lifecycle state of the app. active apps serve connections; suspended apps are provisioned but reject connections.
Possible values: active, suspended
next_cursor
nullable string
必填
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
必填
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
必填
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
total
nullable integer
Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.