Skip to navigation
API Referenceusers

Invite a user to your workspace

Send an invitation email to a new workspace member.

  • Returns 201 on first invite, 200 on resend (same email, pending invite).
  • 409 if the email already belongs to a user in this workspace.
  • 404 if profile_id (or legacy role_id) is provided but not found in this tenant.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
profile_idstring or nullOptionalformat: "uuid"
role_idstring or nullOptionalformat: "uuid"

Response

Successful Response
idstringformat: "uuid"
emailstring
invited_bystring or nullformat: "uuid"
expires_atdatetime
accepted_atdatetime or null
revoked_atdatetime or null
created_atdatetime
profile_idstring or nullOptionalformat: "uuid"
role_idstring or nullOptionalformat: "uuid"

Errors

422
Unprocessable Entity Error