The invitation object

An invitation asks somebody, by email address, to join the organization with a role. They become a member by accepting it through the link it sends, which works for seven days.

Attributes

• idstring (UUID)

  The invitation’s unique identifier.

• objectstring

  The object’s type, always invitation.

  Always invitation

• emailstring

  The address the invitation was sent to.

• expires_attimestamp

  When the invitation stops being accepted.

• roleenum

  The role accepting the invitation grants. One of viewer, writer or admin — see Core.Accounts.Role.

  One of guest, viewer, writer, admin, owner

Example

{
  "email": "sam@example.com",
  "expires_at": "2026-10-26T15:30:00Z",
  "id": "0199c3e4-2a7b-7f10-9c8d-4e6f1a3b5d27",
  "object": "invitation",
  "role": "writer"
}

Endpoints

• GET/v1/invitationsList invitations
• POST/v1/invitationsCreate an invitation
• POST/v1/invitations/:id/resendResend an invitation
• DELETE/v1/invitations/:idCancel an invitation