Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
User

Create a new User

Creates a new application User and sends them an invitation email.

post/users

Request body

emailstring email required

The email address must not match any existing User's email.

role'admin' | 'member' required

Role assigned to the User in the Organization.

locale'en' | 'fr' | 'de' | 'it' | 'nl' | 'es' | 'pl' | 'pt' | 'ro' required

Locale settings used for communication.

workspacesUUID[] required

The new User must be associated with at least one Workspace in the Organization.

first_namestring
last_namestring
phone_numberstring nullable

E.164 format

job_titlestring safe-string nullable

This property is a Safe String.

Example request

{
  "email": "john.doe@example.com",
  "locale": "fr",
  "workspaces": [
    "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
  ],
  "phone_number": "+41446667700",
  "job_title": "Employee"
}

Response

Created

idstring uuid required

Unique identifier of the User.

emailstring email required

Email of the User.

locale'en' | 'fr' | 'de' | 'it' | 'nl' | 'es' | 'pl' | 'pt' | 'ro' required

Locale of the User.

statusstring required

The status of the User. Upon receiving the webhook event, status will always be completed.

is_activeboolean required

Whether the User is active.

role'member' | 'admin' required

User’s role.

Example response

{
  "id": "550e8402-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "locale": "fr",
  "status": "completed",
  "is_active": true,
  "role": "member"
}