Guides

Retrieves a list of devices associated with your organization.

Authorization

This endpoint requires Authorization.

Response

Returns Paginated data of the following format for each item:

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.
statusstringCurrent status of the device: "online", "offline", "error".
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.
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.
Language
Authorization
Header
Click Try It! to start a request and see the response here!