MImistral
beta.admin.user-groups

Get User Group Members

Changed on

Get members of a user group.

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

Request

Path parameters

group_uuidstring uuid required

User group ID.

Query parameters

pageinteger

Page number to return.

page_sizeinteger

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

  • f42449e21ee5Revision changes
    • warning

      for the query request parameter page, the exclusiveMinimum was set to 0.00

  • fa73befe1c61Revision changes
    • warning

      for the query request parameter page_size, the exclusiveMinimum was set to 0.00

    • warning

      for the query request parameter page_size, the max was set to 100.00