API Reference

Admin

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Groups

List groups

$ openai admin:organization:groups list

GET/organization/groups

Create group

$ openai admin:organization:groups create

POST/organization/groups

Retrieve group

$ openai admin:organization:groups retrieve

GET/organization/groups/{group_id}

Update group

$ openai admin:organization:groups update

POST/organization/groups/{group_id}

Delete group

$ openai admin:organization:groups delete

DELETE/organization/groups/{group_id}

ModelsExpand 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.

GroupsUsers

List group users

$ openai admin:organization:groups:users list

GET/organization/groups/{group_id}/users

Add group user

$ openai admin:organization:groups:users create

POST/organization/groups/{group_id}/users

Retrieve group user

$ openai admin:organization:groups:users retrieve

GET/organization/groups/{group_id}/users/{user_id}

Remove group user

$ openai admin:organization:groups:users delete

DELETE/organization/groups/{group_id}/users/{user_id}

ModelsExpand Collapse

organization_group_user: object { id, email, name }

Represents an individual user returned when inspecting group membership.

id: string

The identifier, which can be referenced in API endpoints

email: string

The email address of the user.

name: string

The name of the user.

GroupsRoles

List group organization role assignments

$ openai admin:organization:groups:roles list

GET/organization/groups/{group_id}/roles

Assign organization role to group

$ openai admin:organization:groups:roles create

POST/organization/groups/{group_id}/roles

Retrieve group organization role

$ openai admin:organization:groups:roles retrieve

GET/organization/groups/{group_id}/roles/{role_id}

Unassign organization role from group

$ openai admin:organization:groups:roles delete

DELETE/organization/groups/{group_id}/roles/{role_id}