Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
User management

Create invitation

This API invites a new user to your organization by email. If the email has been invited before, the existing invitation is refreshed with a new expiration date.

👍 Tip: The invitation is valid for 7 days. If the user does not accept the invitation within that time frame, they will need to be re-invited.

post/v1/invitations

Request body

emailstring email required

Email address of the invitee.

first_namestring required

Invitee's first name.

last_namestring required

Invitee's last name.

is_managerboolean

Whether to invite as a manager. Managers have additional permissions in the system, such as the ability to view and manage users and invitations. Defaults to false.

Example request

{
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe"
}

Response

Invitation created (or refreshed) successfully

emailstring email

Email address of the invited user.

first_namestring nullable

First name of the invited user.

last_namestring nullable

Last name of the invited user.

is_managerboolean

Indicates whether the invited user was granted manager permissions.

invited_by_account_pkinteger nullable

A unique identifier of the user who sent the invitation.

created_atstring date-time

Timestamp indicating when the invitation was created.

expires_atstring date-time

Timestamp indicating when the invitation expires.

Example response

{
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "invited_by_account_pk": 1042,
  "created_at": "2026-06-08T10:30:00Z",
  "expires_at": "2026-06-15T10:30:00Z"
}