---
title: "List a ring group's members"
canonical: "https://bird.com/docs/api/reference/list-voice-ring-group-members"
---

# List a ring group's members

`GET /v1/voice/ring-groups/{ring_group_id}/members`

Returns the ring group's members, in the order they joined. The default
group's members are the users who are online in the browser phone now.

Ring groups require preview access to inbound browser calling. Without it,
this returns `404 Not Found`.

## Servers

- `https://{region}.platform.bird.com`: Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.
  - `region`: `us1`, `eu1`. Default: `us1`. The region your organization's data is hosted in.
- `https://platform.bird.com`: Region-independent endpoint for authentication and account administration.
- `http://localhost:8080`: Local development.

## Authentication

Use one authentication option:

- `BearerAuth`: HTTP bearer authentication. Pass the API key as a bearer token in the `Authorization` header. Workspace
keys use `bk_{region}_*`; organization master keys use `bm_{region}_*`.
The prefix identifies the region and selects the
API endpoint. Official Bird SDKs and the CLI derive the region from the key.

- `CookieAuth`: Send `bird_session` in cookie. Session cookie set after signing in to the Bird dashboard. The cookie
value is an opaque session token; no session data is stored in the cookie
itself.

## Code samples

**TypeScript**

```ts
const members = await bird.voice.ringGroups.members.list("RING_GROUP_ID");
for (const member of members.data) {
  console.log(member.user_id);
}
```

Examples: [TypeScript](/docs/api/reference/list-voice-ring-group-members.ts.md) · [Python](/docs/api/reference/list-voice-ring-group-members.py.md) · [Go](/docs/api/reference/list-voice-ring-group-members.go.md) · [PHP](/docs/api/reference/list-voice-ring-group-members.php.md) · [CLI](/docs/api/reference/list-voice-ring-group-members.cli.md) · [MCP](/docs/api/reference/list-voice-ring-group-members.mcp.md) · [cURL](/docs/api/reference/list-voice-ring-group-members.curl.md)

## Example response `200`

```json
{
  "data": [
    {
      "user_id": "usr_01krdgeqcxet5s7t44vh8rt9mg",
      "created_at": "2026-10-01T12:00:00Z"
    }
  ]
}
```

## Path parameters

- `ring_group_id` (string, required): ID of the ring group whose members to list or add to.

## Header parameters

- `X-Workspace-Id` (string, optional): 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-Id` (string, optional): 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 body

- `data` (array of object, required): The members, in the order they joined; the default group's online users, by user ID.
- `data.user_id` (string, required): The member's user ID.
- `data.created_at` (nullable string, required): When the user joined the ring group. Null for the default group, whose members are the users online now.

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)