Create invite

Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.

POST /organization/invites

Create invite

cURL

curl --request POST \
  --url https://api.openai.com/v1/organization/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "role": "reader",
  "projects": [
    {
      "id": "<string>",
      "role": "member"
    }
  ]
}
'

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The invite request payload.

email · string · required

Send an email to this address

role · enum<string> · required

owner or reader

Available options: reader, owner

projects · object[]

An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior.

Show child attributes

Response

200 - application/json

User invited successfully.

Represents an individual invite to the organization.

object · enum<string> · required

The object type, which is always organization.invite

Available options: 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 · enum<string> · required

owner or reader

Available options: owner, reader

status · enum<string> · required

accepted,expired, or pending

Available options: accepted, expired, 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 · object[]

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

Show child attributes