Skip to main content
GET
List group members
Returns the members of a group, including each member’s participant ID, role (ADMIN or MEMBER), and status. Results are paginated. Former members who have been removed are assigned a LEFT status and are excluded from the response by default. To include them, pass include_former=true. This is useful for audit trails or understanding group membership history.
For usage patterns and examples, see the Groups guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Group ID

Query Parameters

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

include_former
boolean
default:false

Include former members (LEFT)

Response

List of group members

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results