API Reference

Admin

Organization

Invites

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve invite

admin.organization.invites.retrieve(invite_id) -> Invite { id, created_at, email, 6 more }

GET/organization/invites/{invite_id}

Retrieves an invite.

ParametersExpand Collapse

invite_id: String

ReturnsExpand Collapse

class Invite { 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: Integer

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

formatunixtime

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[Project{ id, role}]

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

id: String

Project’s public ID

role: :member | :owner

Project membership role

One of the following:

:member

:owner

role: :owner | :reader

owner or reader

One of the following:

:owner

:reader

status: :accepted | :expired | :pending

accepted,expired, or pending

One of the following:

:accepted

:expired

:pending

accepted_at: Integer

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

formatunixtime

expires_at: Integer

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

formatunixtime

Retrieve invite

Ruby

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

require "openai"

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

invite = openai.admin.organization.invites.retrieve("invite_id")

puts(invite)

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