Retrieves a list of devices associated with your organization.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Authorization
This endpoint requires Authorization.
Filters
All query filters are optional and combine with AND.
| Parameter | Matches |
|---|---|
space_id | Devices in that space. |
name | Case-insensitive substring of the device name. |
status | Raw status: online, offline, unavailable, error. Comma-separate several values. |
effective_status | ok, warning, error, offline, disconnected, never_seen. Comma-separate several values. |
model_id | Device model UUID. |
connection_method | native, c2c or edge. |
connector_id | The device's connector.id. |
Any other query parameter, an invalid value, or a non-UUID
model_id/connector_idis rejected with422— unsupported filters are never silently ignored.
Response
Returns Paginated data; this endpoint pages with next_page (the next page number, null on the last page) rather than has_next_page. Each item has the following format:
statusvseffective_status
statusis the device's own reported operational state (online/offline/unavailable/error).
effective_statusis the aggregated health view shown in the Xyte UI. It combines the
rawstatuswith active incidents, connectivity to the integration/proxy, and the
parent device's state. Useeffective_statuswhen you want the same health signal
users see in the dashboard; usestatuswhen you only care about the device's
self-reported state.
merged_effective_statusis the merge-aware rollup ofeffective_statusacross a
merged device group (the primary device and its merged shadows). It is maintained on
the primary/standalone device; for an unmerged device it mirrorseffective_status.
| Key | Subkey | Type | Description |
|---|---|---|---|
| id | string | Unique identifier of the device. It is a universally unique identifier (UUID). | |
| name | string | Name of the device. | |
| sn | string | Serial number of the device. | |
| mac | string | MAC address of the device. This can be null if not available. | |
| cloud_id | string | Unique identifier of the device within the Xyte cloud. | |
| status | string | Device's self-reported operational state: online, offline, error. | |
| effective_status | string | Aggregated 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. | |
| merged_effective_status | string | Merge-aware rollup of effective_status across the device group (primary + merged shadows), maintained on the primary/standalone device. Same value set as effective_status. For an unmerged device it mirrors effective_status. | |
| last_seen_at | string | Date and time when the device was last seen online in ISO 8601 format (e.g., "2024-07-24T07:22:20.037Z"). | |
| details | object | Contains additional details about the device. This can be null if not available. | |
| custom_vendor_name | string | The device's vendor name override, as set through Update Device. Defaults to the vendor's name when no override has been set. | |
| custom_model_name | string | The device's model name override, as set through Update Device. Defaults to the device model's name when no override has been set. | |
| model | object | Contains information about the device's model. | |
| id | string | Unique identifier of the device model. It is a universally unique identifier (UUID). | |
| name | string | Name of the device model. Returns custom_model_name when an override is set. | |
| sub_model | string | The submodel of the device, in the event that different products share the same model. This can be null if not applicable. | |
| beta | boolean | Whether the device model is in beta. | |
| firmware | object | Contains information about the device's firmware. | |
| version | string | Version of the firmware installed on the device. | |
| space | object | Contains information about the space that claimed the device. | |
| id | integer | Unique identifier of the space. | |
| full_path | string | Hierarchical path of the space where the device is located. | |
| connector | object | How the device connects to Xyte. | |
| type | string | native, c2c or edge. | |
| id | string | UUID of the C2C integration or Edge; null for native devices and for a C2C device whose connector was removed (an Edge device keeps the removed Edge's id). Use it as the connector_id filter of Get Devices. | |
| name | string | Display name of the cloud connector (e.g. Zoom), or the Edge display name; null for native devices, or when the connector or Edge was removed. |