Skip to main content
GET
List group members

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

group_id
string
required

ID of the group whose members to list. Get it from id in List workspace groups.

Query Parameters

workspaceId
string
required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Minimum string length: 1
search
string | null

Only return members whose email or name contains this text, ignoring case. Up to 254 characters.

Maximum string length: 254
offset
integer
default:0

Number of members to skip. Defaults to 0.

Required range: x >= 0
limit
integer
default:50

Number of members to return, from 1 to 200. Defaults to 50.

Required range: 1 <= x <= 200

Response

One page of the group's members.

members
GroupMemberItem · object[]
required

Members on this page, sorted by email.

Example:
total
integer
required

Number of members that match search, across all pages.

Example:

12

has_more
boolean
required

Whether more members follow this page.

Example:

false