v1

latestOpenAPI 3.1.02026-08-041529124.1 KB

Groups

Get group details

Retrieve detailed information about a specific group

get/v2/groups/{groupId}

Path parameters

groupIdstring required

Group ID

Response

Successfully retrieved group details

created_atstring date-time

Group creation date

display_namestring

Group name

idstring

Unique identifier for the group

last_refresh_atstring date-time

Group membership last updated date (can be null if initial membership calculation is still in progress)

status'ACTIVE' | 'ARCHIVED'

Group status

type'GENERAL' | 'NEW_HIRE' | 'REMEDIATION'

Group type

Example response

{
  "created_at": "2024-01-15T08:30:00Z",
  "display_name": "Engineering Team",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_refresh_at": "2024-12-01T10:15:00Z",
  "status": "ACTIVE",
  "type": "GENERAL"
}