Skip to content
Start here

Invites

List Invitations
client.User.Invites.List(ctx) (*SinglePage[Invite], error)
GET/user/invites
Invitation Details
client.User.Invites.Get(ctx, inviteID) (*Invite, error)
GET/user/invites/{invite_id}
Respond to Invitation
client.User.Invites.Edit(ctx, inviteID, body) (*Invite, error)
PATCH/user/invites/{invite_id}
ModelsExpand Collapse
type Invite struct{…}
InvitedMemberID string

ID of the user to add to the organization.

maxLength32
OrganizationID string

ID of the organization the user will be added to.

maxLength32
ID stringoptional

Invite identifier tag.

maxLength32
ExpiresOn Timeoptional

When the invite is no longer active.

formatdate-time
InvitedBy stringoptional

The email address of the user who created the invite.

maxLength90
InvitedMemberEmail stringoptional

Email address of the user to add to the organization.

maxLength90
InvitedOn Timeoptional

When the invite was sent.

formatdate-time
OrganizationIsEnforcingTwofactor booloptional
OrganizationName stringoptional

Organization name.

maxLength100
Roles []stringoptional

List of role names the membership has for this account.

Status InviteStatusoptional

Current status of the invitation.

One of the following:
const InviteStatusPending InviteStatus = "pending"
const InviteStatusAccepted InviteStatus = "accepted"
const InviteStatusRejected InviteStatus = "rejected"
const InviteStatusExpired InviteStatus = "expired"