API Reference

Admin

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

List users

GET/organization/users

Retrieve user

GET/organization/users/{user_id}

Modify user

POST/organization/users/{user_id}

Delete user

DELETE/organization/users/{user_id}

ModelsExpand Collapse

OrganizationUser object { id, added_at, object, 13 more }

Represents an individual user within an organization.

id: string

The identifier, which can be referenced in API endpoints

added_at: number

The Unix timestamp (in seconds) of when the user was added.

formatunixtime

object: "organization.user"

The object type, which is always organization.user

api_key_last_used_at: optional number

The Unix timestamp (in seconds) of the user’s last API key usage.

formatunixtime

created: optional number

The Unix timestamp (in seconds) of when the user was created.

formatunixtime

developer_persona: optional string

The developer persona metadata for the user.

email: optional string

The email address of the user

is_default: optional boolean

Whether this is the organization’s default user.

is_scale_tier_authorized_purchaser: optional boolean

Whether the user is an authorized purchaser for Scale Tier.

is_scim_managed: optional boolean

Whether the user is managed through SCIM.

is_service_account: optional boolean

Whether the user is a service account.

name: optional string

The name of the user

projects: optional object { data, object }

Projects associated with the user, if included.

data: array of object { id, name, role }

id: optional string

name: optional string

role: optional string

object: "list"

role: optional string

owner or reader

technical_level: optional string

The technical level metadata for the user.

user: optional object { id, object, banned, 5 more }

Nested user details.

id: string

object: "user"

banned: optional boolean

banned_at: optional number

formatunixtime

email: optional string

enabled: optional boolean

name: optional string

picture: optional string

UserDeleteResponse object { id, deleted, object }

id: string

deleted: boolean

object: "organization.user.deleted"

UsersRoles

List user organization role assignments

GET/organization/users/{user_id}/roles

Assign organization role to user

POST/organization/users/{user_id}/roles

Unassign organization role from user

DELETE/organization/users/{user_id}/roles/{role_id}

ModelsExpand Collapse

RoleListResponse object { id, created_at, created_by, 8 more }

Detailed information about a role assignment entry returned when listing assignments.

id: string

Identifier for the role.

created_at: number

When the role was created.

formatunixtime

created_by: string

Identifier of the actor who created the role.

created_by_user_obj: map[unknown]

User details for the actor that created the role, when available.

description: string

Description of the role.

metadata: map[unknown]

Arbitrary metadata stored on the role.

name: string

Name of the role.

permissions: array of string

Permissions associated with the role.

predefined_role: boolean

Whether the role is predefined by OpenAI.

resource_type: string

Resource type the role applies to.

updated_at: number

When the role was last updated.

formatint64

RoleCreateResponse object { object, role, user }

Role assignment linking a user to a role.

object: "user.role"

Always user.role.

role: Role { id, description, name, 4 more }

Details about a role that can be assigned through the public Roles API.

user: OrganizationUser { id, added_at, object, 13 more }

Represents an individual user within an organization.

RoleDeleteResponse object { deleted, object }

Confirmation payload returned after unassigning a role.

deleted: boolean

Whether the assignment was removed.

object: string

Identifier for the deleted assignment, such as group.role.deleted or user.role.deleted.