Sign inGet Started

List members on a presence channel

GET
/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}/members
const { members } = await bird.realtime.channels.members("rap_01krdgeqcxet5s7t44vh8rt9mg", "presence-lobby");
for (const member of members) console.log(member.member_id);

Lists the member IDs currently subscribed to a presence channel. IDs only: member_info (the profile data attached by your authorization endpoint) is delivered to subscribed clients over the realtime connection and is not available over REST.

Parameters

realtime_app_idstring

ID of the Realtime app (rap_ prefix), as returned when the app was created.

channel_namestring

Name of the presence channel whose members to list.

Response Payload

members
array of object
required
Show child attributes
members.member_id
string
required

An app-defined member ID for your application's end user, assigned when your auth server authorizes them. Use up to 128 URL-safe characters because member IDs appear directly in API request paths. The value can include + : @ . _ -, but not / ? # % or whitespace.

Continue with the documentation, guides and examples for this topic.