API Reference

Admin

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Invites

List invites

admin.organization.invites.list(**kwargs) -> ConversationCursorPage<Invite { id, created_at, email, 6 more } >

GET/organization/invites

Create invite

admin.organization.invites.create(**kwargs) -> Invite { id, created_at, email, 6 more }

POST/organization/invites

Retrieve invite

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

GET/organization/invites/{invite_id}

Delete invite

admin.organization.invites.delete(invite_id) -> InviteDeleteResponse { id, deleted, object }

DELETE/organization/invites/{invite_id}

ModelsExpand 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

class InviteDeleteResponse { id, deleted, object }

id: String

deleted: bool

object: :"organization.invite.deleted"

The object type, which is always organization.invite.deleted