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(strinvite_id) -> Invite

GET/organization/invites/{invite_id}

Retrieves an invite.

ParametersExpand Collapse

invite_id: str

ReturnsExpand Collapse

class Invite: …

Represents an individual invite to the organization.

id: str

The identifier, which can be referenced in API endpoints

created_at: int

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

formatunixtime

email: str

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

object: Literal["organization.invite"]

The object type, which is always organization.invite

projects: List[Project]

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

id: str

Project’s public ID

role: Literal["member", "owner"]

Project membership role

One of the following:

"member"

"owner"

role: Literal["owner", "reader"]

owner or reader

One of the following:

"owner"

"reader"

status: Literal["accepted", "expired", "pending"]

accepted,expired, or pending

One of the following:

"accepted"

"expired"

"pending"

accepted_at: Optional[int]

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

formatunixtime

expires_at: Optional[int]

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

formatunixtime

Retrieve invite

Python

HTTP

TypeScript

Python

Java

Go

Ruby

Terraform

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
invite = client.admin.organization.invites.retrieve(
    "invite_id",
)
print(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
}