Skip to content
Fleet Fleet beta

Create a user

POST
/users

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
email
required

Work email used as the primary identifier. Personal addresses may be rejected; the address must be unique among active users.

string format: email
Example
[email protected]
first_name

Given name (display and HR profile).

string
>= 1 characters
Example
Ada
last_name

Family name (display and HR profile).

string
>= 1 characters
Example
Lovelace
phone

Contact phone number.

string
>= 1 characters
Example
+33123456789
phone_country

ISO 3166-1 alpha-2 country code for phone / dialing context.

string
Example
FR
language

Preferred UI language code (e.g. en, fr). Defaults to the company’s default when omitted on create.

string
>= 1 characters
Example
fr
position

Job title or position label.

string
>= 1 characters
Example
Software engineer
arrival_date

Employment start date as a date or ISO 8601 datetime string.

string
>= 1 characters
Example
2024-01-15
departure_date

Employment end date as a date or ISO 8601 datetime string.

string
>= 1 characters
Example
2026-12-31
date_of_birth

Date of birth as a date or ISO 8601 datetime string (HR profile).

string
>= 1 characters
Example
1990-05-21
city_of_birth

City of birth (HR profile).

string
>= 1 characters
Example
Paris
country_of_birth

Country of birth (HR profile).

string
>= 1 characters
Example
FR
role

EMPLOYEE: standard company user. ADMIN: can manage company configuration and users. On create, defaults to EMPLOYEE when omitted.

string
Allowed values: EMPLOYEE ADMIN
Example
EMPLOYEE
team_ids

Ids of company teams to assign. Teams must already exist. On patch, replaces all current team memberships when provided.

Array<integer>
Example
[
  12,
  34
]

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created user

object
data
required
object
id
required
integer
email
required
string
nullable
secondary_email
required
string
nullable
first_name
required
string
nullable
last_name
required
string
nullable
phone
required
string
nullable
phone_country
required
string
nullable
language
required
string
nullable
position
required
string
nullable
role
required

EMPLOYEE: standard company user. ADMIN: can manage company configuration and users. On create, defaults to EMPLOYEE when omitted.

string
Allowed values: EMPLOYEE ADMIN
Example
EMPLOYEE
arrival_date
required
string
nullable
departure_date
required
string
nullable
date_of_birth
required
string
nullable
city_of_birth
required
string
nullable
country_of_birth
required
string
nullable
teams
required

Teams the user belongs to, sorted by label.

Array<object>
object
id
required
integer
label
required
string