Skip to content
Fleet Fleet beta

List company users

GET
/users

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit

Page size (max 100)

integer
default: 50 >= 1 <= 100
Example
50
offset

Number of items to skip

integer
0 nullable
0
search

Search by first name, last name, or email

string
Example
[email protected]

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated users

object
data
required
Array<object>
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
meta
required
object
total
required

Total items matching filters (before paging)

integer
Example
42
limit
required

Page size used for this response

integer
Example
50
offset
required

Offset used for this response

integer
0