---
title: "List a Realtime app's keys"
method: GET
path: "/v1/realtime/apps/{realtime_app_id}/keys"
tags: ["realtime-apps"]
---

# List a Realtime app's keys

`GET /v1/realtime/apps/{realtime_app_id}/keys`

## Request

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

Returns the app's keys, oldest first. Non-revoked only by default; pass include_revoked=true to include revoked keys. An app can hold several keys at once (create a new key, roll it out, then revoke the old one for zero-downtime rotation). Secrets are never included in this response.

## Query parameters

- `include_revoked` boolean

## Headers

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

## Response `200`

The app's keys.

- RealtimeAppKeyList
  - `data` RealtimeAppKey[], required: The app's keys, oldest first. Revoked keys are excluded unless `include_revoked`=`true`.
    - `id` string, required
    - `key` string, required: The public app key clients use to connect.
    - `secret` string: The key secret, used for server-side request signing. Returned only when the key is created, and never shown again: store it securely. If lost, create a new key and revoke this one.
    - `revoked_at` string, date-time, nullable, required: When the key was revoked, or `null` if still active.
    - `created_at` string, date-time, required

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