API Reference

Admin

Organization

Groups

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve group

admin.organization.groups.retrieve(group_id) -> Group { id, created_at, group_type, 2 more }

GET/organization/groups/{group_id}

Retrieves a group.

ParametersExpand Collapse

group_id: String

ReturnsExpand Collapse

class Group { id, created_at, group_type, 2 more }

Details about an organization group.

id: String

Identifier for the group.

created_at: Integer

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

formatunixtime

group_type: :group | :tenant_group

The type of the group.

One of the following:

:group

:tenant_group

is_scim_managed: bool

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

name: String

Display name of the group.

Retrieve group

Ruby

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

group = openai.admin.organization.groups.retrieve("group_id")

puts(group)

{
    "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"
}