Skip to content
Product Docs

Invites

List Invites
client.invites.listMine(InviteListMineParams { page_size, page_token } query?, RequestOptionsoptions?): PaginatedCursor<Invite { id, organization_id, organization_name, 3 more } >
GET/api/v2/invites
Decline Invite
client.invites.decline(stringinviteID, RequestOptionsoptions?): void
DELETE/api/v2/invites/{invite_id}
Accept Invite
client.invites.accept(stringinviteID, RequestOptionsoptions?): InviteAcceptResponse { organization_id }
POST/api/v2/invites/{invite_id}/accept
ModelsExpand Collapse
Invite { id, organization_id, organization_name, 3 more }

A pending invitation visible to the invitee.

id: string

The invite’s unique identifier.

organization_id: string

The organization the user is invited to.

organization_name: string

The organization’s display name.

role: string

The role being granted (e.g. admin, viewer).

created_at?: string | null

Creation datetime

formatdate-time
updated_at?: string | null

Update datetime

formatdate-time
InviteAcceptResponse { organization_id }

Response for accepting an invitation.

organization_id: string

The organization the user just joined.