Skip to content

List company devices

GET
/devices
curl --request GET \
--url 'https://api.fleet.co/platform/v1/devices?limit=50&offset=0&search=macbook%20SN123&user_id=12&client_status=ARCHIVED&location_type=NONE' \
--header 'Authorization: Bearer <token>'
limit

Page size (max 100)

integer
default: 50 >= 1 <= 100

Example

50
offset

Number of items to skip

integer
0

Example

0
search

Search by device name, serial number, assignee, or team

string

Example

macbook SN123
user_id

Filter by assigned user id

integer

Example

12
client_status

Filter by client_status (same values as the response client_status field)

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

Filter by location.type (same values as the response location.type field)

string
Allowed values: NONE AT_REPAIRER FLEET_STORAGE STOCK_REGION IN_TRANSIT COMPANY_ADDRESS

Paginated devices

Media typeapplication/json
object
data
required
Array<object>
object
id
required
integer
name
required
string
nullable
brand
required
string
nullable
serial_number
required
string
nullable
imei
required
string
nullable
internal_id
required

Company asset tag

string
nullable
user_id
required

Assigned user id; load the user with GET /users/:id

integer
nullable
assigned_address_id
required

Company address where the device is kept once delivered

integer
nullable
shipping_address_id
required

Company address of the first delivery

integer
nullable
location
required
object
type
required

Where the device is now. IN_TRANSIT covers the first delivery and transfers; COMPANY_ADDRESS means it sits at assigned_address_id.

string
Allowed values: NONE AT_REPAIRER FLEET_STORAGE STOCK_REGION IN_TRANSIT COMPANY_ADDRESS
address_id
required

Company address of the location: the destination when IN_TRANSIT, the assigned address when COMPANY_ADDRESS. Null for Fleet-managed locations (repairer, Fleet storage, stock region, reconditioning).

integer
nullable
created_at
required
string
nullable
updated_at
required
string
nullable
rent
required
string
nullable
tracking_number
required
string
nullable
tracking_url
required

Tracking page URL.

string
nullable
shipping_date
required

Initial delivery shipment date (ISO 8601).

string
nullable
delivery_date
required

Initial delivery completion date (ISO 8601).

string
nullable
expected_delivery_date
required

Carrier-estimated initial delivery date (ISO 8601).

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 code used for pricing and device configuration.

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 SWEDISH_QWERTY NORWEGIAN_QWERTY DANISH_QWERTY FINNISH_QWERTY OTHER
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 details once enrollment has started; null otherwise

object
id
required
integer
status
required

MDM enrollment status.

string
Allowed values: 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
order
required
object
order_id
required
integer
client_status
required

Order progress key for display and filtering

string
Allowed values: RECEIVED BEING_PROCESSED FINANCING_REQUEST DOC_REQUIRED SIGNING PROCESSING SHIPPED RECEPTION_TO_CONFIRM ONGOING_ORDER PENDING_DECISION EQUIPMENT_TO_SEND ARCHIVED FAILED UNKNOWN
device_names
required

Display names for devices on the order

Array<string>
rent
required
string
nullable
rent_currency
required
string
nullable
order_number
required
string
nullable
contract_number
required
string
nullable
order_date
required
string
nullable
num_devices
required
integer
nullable
fulfillment_mode
required

DIRECT_DELIVERY ships devices to their users; STOCK ships them to the company’s stock

string
Allowed values: DIRECT_DELIVERY STOCK
created_at
required
string
nullable
updated_at
required
string
nullable
repair
required

Open repair; closed repairs are listed by GET /repairs?device_id=

object
id
required
integer
device_id
required
integer
status
required

Repair progress. COMPLETED and CANCELLED are closed repairs.

string
Allowed values: REQUEST_RECEIVED AWAITING_PICKUP PICKED_UP REPAIR_IN_PROGRESS IN_RETURN COMPLETED ON_HOLD CANCELLED
repairer
required
string
nullable
pickup_tracking
required

Tracking number of the pickup to the repairer

string
nullable
return_tracking
required

Tracking number of the return from the repairer

string
nullable
loan_device_id
required

Company device lent during the repair

integer
nullable
requested_at
required
string
nullable
picked_up_at
required
string
nullable
returned_at
required
string
nullable
closed_at
required
string
nullable
created_at
required
string
nullable
updated_at
required
string
nullable
storage
required

Current storage stay (ACTIVE or ENDING); past stays are listed by GET /storage-stays?device_id=

object
id
required
integer
device_id
required
integer
status
required

ACTIVE: stored at Fleet. ENDING: on its way back. ENDED: delivered back. CANCELLED: never stored.

string
Allowed values: ACTIVE ENDING ENDED CANCELLED
country_code
required

Country of the Fleet storage (ISO alpha-2)

string
nullable
factory_reset
required

Whether the device was factory reset on intake

boolean
nullable
quality
required

Condition graded on intake

string
nullable
inbound_parcel_id
required

Shipment to the storage; listed in the device parcels

integer
nullable
outbound_parcel_id
required

Shipment out of the storage; listed in the device parcels

integer
nullable
started_at
required
string
nullable
ended_at
required
string
nullable
created_at
required
string
nullable
updated_at
required
string
nullable
parcels
required

Return and inter-office shipments for this device, newest first. Initial delivery uses the device tracking_number and tracking_url. Load addresses with GET /addresses/:id.

Array<object>
object
id
required
integer
type
required

RETURN: device return shipment. INTER_OFFICE_DELIVERY: inter-office move.

string
Allowed values: RETURN INTER_OFFICE_DELIVERY STORAGE_INBOUND STORAGE_OUTBOUND
status
required

Parcel shipment progress. CANCELLED: the shipment was called off before delivery.

string
Allowed values: WAITING SCHEDULED SHIPPED RECEIVED FAILED CANCELLED
tracking_number
required
string
nullable
tracking_url
required

Tracking page URL.

string
nullable
carrier
required
string
nullable
pickup_address_id
required
integer
nullable
reception_address_id
required
integer
nullable
pickup_date
required
string
nullable
reception_date
required
string
nullable
shipping_date
required
string
nullable
created_at
required
string
nullable
meta
required
object
total
required

Total items matching filters (before paging)

integer
limit
required

Page size used for this response

integer
offset
required

Offset used for this response

integer

Example

{
"data": [
{
"location": {
"type": "NONE"
},
"client_status": "ARCHIVED",
"characteristics": {
"keyboard_layout": "FRENCH_AZERTY"
},
"mdm": {
"status": "SUBSCRIBED"
},
"order": {
"client_status": "RECEIVED",
"fulfillment_mode": "DIRECT_DELIVERY"
},
"repair": {
"status": "REQUEST_RECEIVED"
},
"storage": {
"status": "ACTIVE"
},
"parcels": [
{
"type": "RETURN",
"status": "WAITING"
}
]
}
],
"meta": {
"total": 42,
"limit": 50,
"offset": 0
}
}

Validation error

Media typeapplication/json
object
message
required

Every validation failure, comma-separated

string
type
required
string
Allowed values: validation_error
error
required
string
Allowed values: validation_error

Example

{
"message": "Required, must be an ISO 3166-1 alpha-2 country code",
"type": "validation_error",
"error": "validation_error"
}

Missing, invalid, or revoked API key

Media typetext/plain
string

Example

Unauthorized

Rate limit exceeded. The RateLimit-* headers give the limit and the reset time.

Media typetext/plain
string

Example

Too many requests, please try again later.

Unexpected server error

Media typeapplication/json
object
error
required
string
Allowed values: INTERNAL_ERROR

Example

{
"error": "INTERNAL_ERROR"
}

Rate limiting is temporarily unavailable; retry with backoff

Media typeapplication/json
object
message
required
string

Example generated

{
"message": "example"
}