Skip to content
Fleet Fleet Platform API

List company devices

GET
/devices

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

Full-text search on device search_field (tsquery) and related assignee/tag fields

string
Example
macbook SN123
user_id

Filter by assigned user id

integer
Example
12
client_status

Filter by computed client_status (same uppercase keys as response client_status; applied in SQL)

string
Allowed values: ARCHIVED PENDING_VALIDATION IN_PREPARATION DELIVERED SHIPPED AVAILABLE IN_SERVICE IN_MAINTENANCE OUT_OF_SERVICE

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated devices

object
data
required
Array<object>
object
id
required
integer
name
required
string
nullable
serial_number
required
string
nullable
rent
required
string
nullable
tracking_number
required
string
nullable
client_status
required

Device progress key for display and filtering

string
Allowed values: ARCHIVED PENDING_VALIDATION IN_PREPARATION DELIVERED SHIPPED AVAILABLE IN_SERVICE IN_MAINTENANCE OUT_OF_SERVICE
type
required
string
nullable
category
required
string
nullable
source
required
string
nullable
comment
required

Free-form device comment

string
nullable
characteristics
required
object
screen_size
required
string
nullable
graphic
required
string
nullable
processor
required
string
nullable
ram
required
string
nullable
storage
required
string
nullable
model_year
required
string
nullable
connectivity
required
string
nullable
keyboard_layout
required

Keyboard layout for delivery pricing (maps to Fleet keyboard_layouts.type)

string
nullable
Allowed values: FRENCH_AZERTY SPANISH_QWERTY ITALIAN_QWERTY INTERNATIONAL_ENGLISH_QWERTY GERMAN_QWERTZ PORTUGUESE_QWERTY ENGLISH_QWERTY SWISS_QWERTZ AMERICAN_ENGLISH_QWERTY CANADIAN_ENGLISH_QWERTY DUTCH_QWERTY
Example
FRENCH_AZERTY
resolution
required
string
nullable
has_microphone
required
boolean
nullable
has_webcam
required
boolean
nullable
noise_cancellation
required
boolean
nullable
compliance
required
Array<string>
nullable
connection_type
required
Array<string>
nullable
has_stool
required
boolean
nullable
has_video_package
required
boolean
nullable
has_screen
required
boolean
nullable
has_premium_tablet
required
boolean
nullable
color
required
string
nullable
seats_number
required
string
nullable
assembly
required
string
nullable
os_platform
required
string
nullable
mdm
required

MDM enrollment row when present (non-deleted, non-DRAFT); null otherwise

object
id
required
integer
status
required

Raw MDM enrollment status from devices_mdm. DRAFT rows are omitted by the device relation; other values match DB enum.

string
Allowed values: DRAFT SUBSCRIBED DOWNLOADED IDENTIFIED ENROLLMENT_IN_PROGRESS ENROLLED UNENROLLED DEVICE_WIPE_PENDING
local_name
required
string
nullable
is_locked
required
boolean
nullable
lock_date
required
string
nullable
firewall_enabled
required
boolean
nullable
os_updates_enabled
required
boolean
nullable
is_encrypted
required
boolean
nullable
screenlock_enabled
required
boolean
nullable
is_compromised
required
boolean
nullable
os_updates_available
required
boolean
nullable
disk_encryption_profile_installed
required
boolean
nullable
enrollment_date
required
string
nullable
unenrollment_date
required
string
nullable
download_date
required
string
nullable
last_seen_date
required
string
nullable
last_sync_date
required
string
nullable
meta
required
object
total
required

Total rows matching filters (before paging)

integer
Example
42
limit
required

Requested page size after validation

integer
Example
50
offset
required

Requested offset after validation

integer
0

400

Section titled “400 ”

Validation error

object
error
required
string