Sign in
beta.admin.user-groups

Get User Group Members

Get members of a user group.

get/v1/admin/user-groups/{group_uuid}/members

Path parameters

group_uuidstring uuid required

User group ID.

User group ID.

Query parameters

pageinteger

Page number to return.

Page number to return.

page_sizeinteger

Maximum number of results per page.

Maximum number of results per page.

Response

OK

totalinteger required

Total number of group members that match the request.

pageinteger required

Page number returned.

page_sizeinteger required

Maximum number of results per page.

Example response

{
  "members": [
    {
      "name": "Alice Martin",
      "email": "alice.martin@example.com"
    }
  ]
}

Changes

Changed in 1 of the 3 revisions of this API.1