Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Invites

Retrieve invite

$ openai admin:organization:invites retrieve
GET/organization/invites/{invite_id}

Retrieves an invite.

ParametersExpand Collapse
--invite-id: string

The ID of the invite to retrieve.

ReturnsExpand Collapse
invite: object { id, created_at, email, 6 more }

Represents an individual invite to the organization.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

The Unix timestamp (in seconds) of when the invite was sent.

email: string

The email address of the individual to whom the invite was sent

object: "organization.invite"

The object type, which is always organization.invite

projects: array of object { id, role }

The projects that were granted membership upon acceptance of the invite.

id: string

Project’s public ID

role: "member" or "owner"

Project membership role

"member"
"owner"
role: "owner" or "reader"

owner or reader

"owner"
"reader"
status: "accepted" or "expired" or "pending"

accepted,expired, or pending

"accepted"
"expired"
"pending"
accepted_at: optional number

The Unix timestamp (in seconds) of when the invite was accepted.

expires_at: optional number

The Unix timestamp (in seconds) of when the invite expires.

Retrieve invite

openai admin:organization:invites retrieve \
  --admin-api-key 'My Admin API Key' \
  --invite-id invite_id
{
    "object": "organization.invite",
    "id": "invite-abc",
    "email": "user@example.com",
    "role": "owner",
    "status": "accepted",
    "created_at": 1711471533,
    "expires_at": 1711471533,
    "accepted_at": 1711471533
}
Returns Examples
{
    "object": "organization.invite",
    "id": "invite-abc",
    "email": "user@example.com",
    "role": "owner",
    "status": "accepted",
    "created_at": 1711471533,
    "expires_at": 1711471533,
    "accepted_at": 1711471533
}