Retrieves an invite.

GET /organization/invites/{invite_id}

Path parameters

invite_id string Required

The ID of the invite to retrieve.

Responses

200 application/json

Invite retrieved successfully.
Hide response attributes Show response attributes object
- object string Required
  
  The object type, which is always organization.invite
  
  Value is organization.invite.
- id string Required
  
  The identifier, which can be referenced in API endpoints
- email string Required
  
  The email address of the individual to whom the invite was sent
- role string Required
  
  owner or reader
  
  Values are owner or reader.
- status string Required
  
  accepted,expired, or pending
  
  Values are accepted, expired, or pending.
- invited_at integer Required
  
  The Unix timestamp (in seconds) of when the invite was sent.
- expires_at integer Required
  
  The Unix timestamp (in seconds) of when the invite expires.
- accepted_at integer
  
  The Unix timestamp (in seconds) of when the invite was accepted.
- projects array[object]
  
  The projects that were granted membership upon acceptance of the invite.
  
  Hide projects attributes Show projects attributes object
  
  id string
  
  Project's public ID
  
  role string
  
  Project membership role
  
  Values are member or owner.

GET /organization/invites/{invite_id}

curl \
 --request GET 'https://api.openai.com/v1/organization/invites/{invite_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "object": "organization.invite",
  "id": "string",
  "email": "string",
  "role": "owner",
  "status": "accepted",
  "invited_at": 42,
  "expires_at": 42,
  "accepted_at": 42,
  "projects": [
    {
      "id": "string",
      "role": "member"
    }
  ]
}