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(InviteListParams**kwargs) -> SyncConversationCursorPage[Invite]

GET/organization/invites

Create invite

admin.organization.invites.create(InviteCreateParams**kwargs) -> Invite

POST/organization/invites

Retrieve invite

admin.organization.invites.retrieve(strinvite_id) -> Invite

GET/organization/invites/{invite_id}

Delete invite

admin.organization.invites.delete(strinvite_id) -> InviteDeleteResponse

DELETE/organization/invites/{invite_id}

ModelsExpand 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

class InviteDeleteResponse: …

id: str

deleted: bool

object: Literal["organization.invite.deleted"]

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