Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Admin
Organization
Invites

List invites

$ openai admin:organization:invites list
GET/organization/invites

Returns a list of invites in the organization.

ParametersExpand Collapse
--after: optional string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

--limit: optional number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

ReturnsExpand Collapse
InviteListResponse: object { data, has_more, object, 2 more }
data: array of Invite { id, created_at, email, 6 more }
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.

has_more: boolean

The has_more property is used for pagination to indicate there are additional results.

object: "list"

The object type, which is always list

first_id: optional string

The first invite_id in the retrieved list

last_id: optional string

The last invite_id in the retrieved list

List invites

openai admin:organization:invites list \
  --admin-api-key 'My Admin API Key'
{
  "object": "list",
  "data": [
    {
      "object": "organization.invite",
      "id": "invite-abc",
      "email": "user@example.com",
      "role": "owner",
      "status": "accepted",
      "created_at": 1711471533,
      "expires_at": 1711471533,
      "accepted_at": 1711471533
    }
  ],
  "first_id": "invite-abc",
  "last_id": "invite-abc",
  "has_more": false
}
Returns Examples
{
  "object": "list",
  "data": [
    {
      "object": "organization.invite",
      "id": "invite-abc",
      "email": "user@example.com",
      "role": "owner",
      "status": "accepted",
      "created_at": 1711471533,
      "expires_at": 1711471533,
      "accepted_at": 1711471533
    }
  ],
  "first_id": "invite-abc",
  "last_id": "invite-abc",
  "has_more": false
}