Devices API
Devices API
Manage your devices programmatically with the Devices API.
List Devices
`` GET /v1/devices ``
Query parameters:
page— Page number (default: 1)limit— Items per page (default: 20, max: 100)status— Filter by status:online,offlinestore_id— Filter by storetag— Filter by tag
Response: ``json { "success": true, "data": [ { "id": "dev_abc123", "name": "Lobby Screen 1", "status": "online", "type": "TV", "platform": "android", "store_id": "store_xyz", "last_heartbeat": "2025-01-15T10:30:00Z", "player_version": "1.5.67", "tags": ["lobby", "welcome"] } ] } ``
Get Device Detail
`` GET /v1/devices/:id ``
Returns full device information including hardware metrics, current playlist, and configuration.
Update Device
`` PATCH /v1/devices/:id ``
Request body: ``json { "name": "Updated Name", "store_id": "store_new", "tags": ["updated-tag"], "orientation": "portrait" } ``
Send Command
`` POST /v1/devices/:id/commands ``
Request body: ``json { "command": "REFRESH" } ``
Available commands: REFRESH, REBOOT, APP_RESTART, UPDATE_CHECK
Use the status filter to quickly identify offline devices for automated monitoring scripts.
Delete Device
`` DELETE /v1/devices/:id ``
Removes the device from your organization. The physical device will need to be re-paired.
Device Heartbeat Data
`` GET /v1/devices/:id/heartbeats ``
Query parameters:
from— Start date (ISO 8601)to— End date (ISO 8601)interval— Aggregation interval:minute,hour,day
Returns historical heartbeat data including CPU, memory, disk, temperature, and Wi-Fi signal.
The DELETE endpoint permanently removes a device. This action cannot be undone. The device will display the pairing screen and need to be re-paired.