Skip to content
Docs
Operation

Get device

GET/devices/{deviceId}
Get a device with its peripherals and live status.

Path parameters

deviceIdstringRequired

Returns

Device

Errors

400
Bad Request - Invalid input
401
Unauthorized - Authentication required
403
Forbidden - Insufficient permissions
404
Not Found - Resource not found
500
Internal Server Error

Every error names its code and links to it. All error codes

curl -X GET "https://api.ticketlayer.com/v1/devices/{deviceId}" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug"
Response 200
{
  "device": {
    "id": "string",
    "name": "string",
    "type": "string",
    "status": "string",
    "connectivity": "string",
    "accountId": "string",
    "location": {
      "id": "string",
      "name": "string"
    },
    "hostDeviceId": "string",
    "attachment": "string",
    "clientKey": "string",
    "vendor": "string",
    "model": "string",
    "capabilities": {},
    "liveStatus": {},
    "platform": {},
    "appVersion": "string",
    "local": {
      "hostname": "string",
      "port": 0
    },
    "lastSeenAt": "string",
    "online": true,
    "createdAt": "string",
    "updatedAt": "string",
    "peripherals": [
      {
        "id": "string",
        "name": "string",
        "type": "string"
      }
    ]
  }
}

Try it in test mode

Path parameters