Skip to content
Primary navigation

Retrieve group

$ openai admin:organization:groups retrieve
GET/organization/groups/{group_id}

Retrieves a group.

ParametersExpand Collapse
--group-id: string

The ID of the group to retrieve.

ReturnsExpand Collapse
group: object { id, created_at, group_type, 2 more }

Details about an organization group.

id: string

Identifier for the group.

created_at: number

Unix timestamp (in seconds) when the group was created.

group_type: "group" or "tenant_group"

The type of the group.

"group"
"tenant_group"
is_scim_managed: boolean

Whether the group is managed through SCIM and controlled by your identity provider.

name: string

Display name of the group.

Retrieve group

openai admin:organization:groups retrieve \
  --admin-api-key 'My Admin API Key' \
  --group-id group_id
{
    "id": "group_01J1F8ABCDXYZ",
    "name": "Support Team",
    "created_at": 1711471533,
    "is_scim_managed": false,
    "group_type": "group"
}
Returns Examples
{
    "id": "group_01J1F8ABCDXYZ",
    "name": "Support Team",
    "created_at": 1711471533,
    "is_scim_managed": false,
    "group_type": "group"
}