Get Devices

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authorization

This endpoint requires Authorization.

Response

Returns Paginated data of the following format for each item:

status vs effective_status
status is the device's own reported operational state (online / offline / error).
effective_status is the aggregated health view shown in the Xyte UI. It combines the
raw status with active incidents, connectivity to the integration/proxy, and the
parent device's state. Use effective_status when you want the same health signal
users see in the dashboard; use status when you only care about the device's
self-reported state.

KeySubkeyTypeDescription
idstringUnique identifier of the device. It is a universally unique identifier (UUID).
namestringName of the device.
snstringSerial number of the device.
macstringMAC address of the device. This can be null if not available.
cloud_idstringUnique identifier of the device within the Xyte cloud.
statusstringDevice's self-reported operational state: online, offline, error.
effective_statusstringAggregated health status shown in the Xyte UI, derived from status, active incidents, and connectivity. One of: ok, warning, error, offline, disconnected, never_seen. null until first computed.
last_seen_atstringDate and time when the device was last seen online in ISO 8601 format (e.g., "2024-07-24T07:22:20.037Z").
detailsobjectContains additional details about the device. This can be null if not available.
modelobjectContains information about the device's model.
idstringUnique identifier of the device model. It is a universally unique identifier (UUID).
namestringName of the device model.
sub_modelstringThe submodel of the device, in the event that different products share the same model. This can be null if not applicable.
betabooleanWhether the device model is in beta.
firmwareobjectContains information about the device's firmware.
versionstringVersion of the firmware installed on the device.
spaceobjectContains information about the space that claimed the device.
idintegerUnique identifier of the space.
full_pathstringHierarchical path of the space where the device is located.
Query Params
int32
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json