Skip to content

Command Request

APIs to view and manage command requests. Learn more about commands or how to schedule a command.

Scheduled commands are currently compatible with Android devices.

Operations

List command requests

Request

API to get and filter command requests

Security
apiKey
Query
devicesstring

Filter by device IDs. Accepts comma separated values.

groupsstring

Filter by group IDs. Accepts comma separated values.

commandstring

Filter by command name

schedulestring

Filter by schedule type

Enum:"IMMEDIATE""WINDOW""RECURRING"
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/commands/?devices=string&groups=string&command=string&schedule=IMMEDIATE&exclude_internal_commands=false&limit=0&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Command request list for the Tenant

Bodyapplication/json
codeinteger
messagestring
contentobject
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "count": 0,
    "previous": "string",
    "next": "string",
    "results": [ … ]
  }
}