Skip to content
Fleet Fleet beta

Get one device

GET
/devices/{device_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
device_id
required

Device id

string
/^[1-9]\d*$/
Example
42

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Device

object
data
required
object
id
required
integer
name
required
string
nullable
serial_number
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
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 details when the device is enrolled; 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
Example
BEING_PROCESSED
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
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.

string
Allowed values: WAITING SCHEDULED SHIPPED RECEIVED FAILED
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

404

Section titled “404 ”

Not found

object
error
required
string
Allowed values: DEVICE_NOT_FOUND