Skip to content
Fleet Fleet Platform API

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 or disposable email domains are rejected; the address must be unique among active users.

string format: email
Example
[email protected]
first_name

Given name (display and HR profile).

string
Example
Ada
last_name

Family name (display and HR profile).

string
Example
Lovelace
phone

Contact phone number; spaces are removed before storage.

string
Example
+33123456789
phone_country

Country or dialing context for the phone number (as used by Fleet with phone).

string
Example
FR
password

Optional initial password. If omitted, set access through your usual onboarding or password-reset flow.

string
Example
hunter2
language

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

string
Example
fr
position

Job title or position label.

string
Example
Software engineer
arrival_date

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

string
Example
2024-01-15
departure_date

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

string
Example
2026-12-31
date_of_birth

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

string
Example
1990-05-21
city_of_birth

City of birth (HR profile).

string
Example
Paris
country_of_birth

Country of birth (HR profile).

string
Example
FR
role

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

string
Allowed values: EMPLOYEE ADMIN
Example
EMPLOYEE

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created user

object
data
required
object
id
required
integer
company_id
required
integer
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 in Fleet. 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