Skip to content
Docs
Open Backstage
Operation

List devices

GET/devices
List top-level devices (relays/scanners/kiosks) for the organisation.

Query parameters

accountIdstringOptional
typestringOptional
statusstringOptional
connectivitystringOptional
locationIdstringOptional

Returns

Devices

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" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug"
Response 200
{
  "devices": [
    {
      "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

Query parameters