GET
/
api
/
v1
/
groups
/
{id}
/
users

Path Parameters

id
string
required

The ID of the group to list users for.

Query Parameters

offset
number
default: 0

The offset to start from. If you enter 10, it will start from the 10th user.

Required range: 0 < x < 100
limit
number
default: 10

The number of users to return.

Required range: 1 < x < 100
username
string

The username to search for.

The text string that user email or name will be filtered by.

filter
enum<string>

Whether to filter the list of returned users. 'existingMembers' will only return existing users in the group, 'nonMembers' will only return users not in the group, undefined will return all users in the organization.

Available options:
existingMembers,
nonMembers

Response

200 - application/json
users
object[]
required
totalCount
number
required

Was this page helpful?