Querying Call Members

Creating or joining a call returns up to 100 members (default 25). For complete member lists, use the query API with pagination, filtering, and sorting.

await call.getOrCreate({ members_limit: 100 });
// or
await call.join({ members_limit: 100 });

Best Practices

• Use pagination for calls with many members to avoid loading all data at once.
• Filter by role to quickly find hosts, moderators, or specific participant types.
• Use sorting to present members in a consistent order.
• Cache results when appropriate to reduce API calls.

Examples

Below are a few examples of how to use this API:

const result = await call.queryMembers();

// sorting and pagination
const queryMembersReq = {
  sort: [{ field: "user_id", direction: 1 }],
  limit: 2,
};
const result = await call.queryMembers(queryMembersReq);

// loading the next page
const result = await call.queryMembers({
  ...queryMembersReq,
  next: result.next,
});

// filtering
const result = await call.queryMembers({
  filter_conditions: { role: { $eq: "admin" } },
});

Sort options

Sorting is supported on these fields:

• user_id
• created_at

Filter options

The Stream API allows you to specify filters and ordering for several endpoints. The query syntax is similar to that of Mongoose, however we do not run MongoDB on the backend. Only a subset of the MongoDB operations are supported. See filter operators guide for details.

It's also possible to combine filter expressions with the following operators: