Operation

Get a command

GET/devices/commands/{commandId}

Get a single command’s status/result by id (poll for completion).

Path parameters

commandIdstringRequired

Returns

Command

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/commands/{commandId}" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug"

Response 200

{
  "command": {
    "id": "string",
    "deviceId": "string",
    "peripheralId": "string",
    "type": "string",
    "status": "string",
    "payload": {},
    "idempotencyKey": "string",
    "progress": {},
    "result": {},
    "createdBy": {
      "type": "string",
      "id": "string"
    },
    "expiresAt": "string",
    "createdAt": "string",
    "deliveredAt": "string",
    "completedAt": "string"
  }
}

Get a command

Path parameters

Returns

Errors

Try it in test mode

Path parameters