Get Device

#GET /devices/{id}

Retrieve info about a specific device such as online status, orientation and resolution and playlist.

#Authentication

Set the Authorization header to Bearer {API Key}.

Scopes: device:read

#Path Parameters

Parameter	Description
id	The device ID. In most cases this will be the mac address of the device (ie. c4:23:60:91:c0:6c).

#Responses

#200 (OK)

The device was successfully retrieved.

Field	Description
id  string	The device ID to retrieve. In most cases this will be the mac address of the device (ie. c4:23:60:91:c0:6c).
name  string	The name of the device.
timezone  string	The timezone of the device.
screen_resolution  string	The screen resolution of the device.
screen_orientation  string	The screen orientation of the device.
registered_at  string	When the device was registered using it’s activation code.
published_at  string	When the device was last published to.
last_heartbeat_at  string	When the device last sent a heartbeat. If the device is online, a heartbeat will be sent every few minutes.
is_online  boolean	Whether or not the device is online. Return false if the last_heartbeat_at value is older than 5 minutes ago.
offline_startup  boolean	Whether or not the device will start playing from cache after start up.
offline_startup_delay_minutes integer	How long the device will wait on the WiFi setup screen when offline_startup is enabled.
open_dev_tools  integer	Whether or not the developer tools will be opened on start up.
updated_at  string	When the device was last updated.
created_at  integer	When the device was created. This is typically the date when the device was imaged, before registration.

{
  "id": "c4:23:60:91:c0:6c",
  "name": "Front Lobby",
  "timezone": "America/Los_Angeles",
  "screen_resolution": "1920x1080",
  "screen_orientation": "normal",
  "registered_at": "2024-03-21T17:51:45.732391Z",
  "published_at": "2025-01-15T08:21:49.219648Z",
  "last_heartbeat_at": "2024-01-15T17:08:27.219444Z",
  "is_online": true,
  "offline_startup": true,
  "offline_startup_delay_minutes": 1,
  "open_dev_tools": false,
  "updated_at": "2025-01-15T15:20:15.955849Z",
  "created_at": "2024-03-21T17:51:45.70569Z",
}

#404 (Not Found)

The device does not exist or the provided API key does not have access to this device. The user that the API key is associated with must have update or read access to the device.

{
  "message": "Device not found"
}

#403 (Forbidden)

The API key does not have the device:read scope.

{
  "message": "Invalid scopes"
}

#Next Steps

• Publish Device
• Update Device

---