Sign in
beta.admin.user-groups

Get User Group

Get a specific user group.

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

Path parameters

group_uuidstring uuid required

User group ID.

User group ID.

Response

OK

uuidstring uuid required

User group ID.

namestring required

Name of the user group.

descriptionstring nullable required

Optional description of the user group.

externally_managedboolean nullable

Whether the group is managed by an external system.

target_type'W' | 'O'
organization_rolestring nullable

Organization role assigned to the group.

parent_group_idsstring[]

UUIDs of the groups this group is directly nested inside.

Example response

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

Changes

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