latestOpenAPI 3.1.02026-08-142887561.0 MB

61436a496404

beta.admin.user-groups

Get User Groups

Get all user groups across the organization.

get/v1/admin/user-groups

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.

searchstring nullable

Search term used to filter user groups by name.

Example:Engineering

Search term used to filter user groups by name.

Response

OK

totalinteger required

Total number of user groups that match the request.

pageinteger required

Page number returned.

page_sizeinteger required

Maximum number of results per page.

Example response

{
  "items": [
    {
      "name": "Engineering Team",
      "description": "Members of the platform engineering team",
      "parent_group_ids": [
        "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      ]
    }
  ]
}