Get status list for command request

Request

API to get and filter command request status

Security

apiKey

Query

requeststring

Filter status result by command request IDs. Accepts comma separated values.

devicestring

Filter status result by device IDs. Accepts comma separated values.

statestring

Filter by command state

Enum:"Command Queued""Command Initiated""Command Acknowledged""Command In Progress""Command TimeOut""Command Success""Command Failure""Command Scheduled""Command Cancelled"

exclude_internal_commandsboolean

Filter to exclude internal commands

Default:false

limitnumber

offsetnumber

cURL

curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/commands/v0/status/?request=string&device=string&state=Command%20Queued&exclude_internal_commands=false&limit=0&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Status list for a command request

Bodyapplication/json

codeinteger

messagestring

contentobject

Response

{
  "code": 0,
  "message": "string",
  "content": {
    "count": 0,
    "previous": "string",
    "next": "string",
    "results": [ … ]
  }
}