Invites

List invites

client.admin.organization.invites.list(?, ?): ConversationCursorPage<Invite { id, created_at, email, 6 more } >

GET/organization/invites

Create invite

client.admin.organization.invites.create(, ?): Invite { id, created_at, email, 6 more }

POST/organization/invites

Retrieve invite

client.admin.organization.invites.retrieve(, ?): Invite { id, created_at, email, 6 more }

GET/organization/invites/{invite_id}

Delete invite

client.admin.organization.invites.delete(, ?): InviteDeleteResponse { id, deleted, object }

DELETE/organization/invites/{invite_id}

ModelsExpand Collapse

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: number

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>

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?: number | null

The Unix timestamp (in seconds) of when the invite was accepted.

formatunixtime

expires_at?: number | null

The Unix timestamp (in seconds) of when the invite expires.

formatunixtime

InviteDeleteResponse { id, deleted, object }

id: string

deleted: boolean

object: "organization.invite.deleted"

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

Suggested

Invites

List invites

Create invite

Retrieve invite

Delete invite

ModelsExpand Collapse