Commands V2

Commands V2.0 provides advanced device commands capabilities like queuing, support for offline devices, dynamic device set for commands and command history. Commands 2.0 is in active development and we will add support for all the commands soon

Find out more about commands V2.0

Operations

List command requests
Legacy

Request

Alternative Available (recommended): For broader multi-OS support and enhanced command visibility, use the stable command request API: https://api.esper.io/openapi/command-request/listcommandrequests

Returns a paginated list of command requests within the enterprise. Each record includes the command type, targeted devices or groups, schedule details, arguments, and current status.

This endpoint provides visibility into commands that have been issued, whether they are queued, in progress, successful, or failed.

Security

esper_cloud_api_apiKey

Path

enterprise_idstring, (uuid)required

ID of the enterprise

Query

command_typestring

Filter by type of command request i.e device, group etc

devicesstring

Filter by device IDs. Accepts comma separated values.

device_typestring

Filter by device type i.e active, inactive etc

commandstring

Filter by command name

issued_bystring

Filter by user. Accepts user id.

cURL

curl -i -X GET \
  'https://api.esper.io/_mock/openapi/v0/enterprise/{enterprise_id}/command/?command_type=string&devices=string&device_type=string&command=string&issued_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

on successful request

Bodyapplication/json

countinteger, (int64)

nextstring, (url)

previousstring, (url)

resultsArray of objects(esper_cloud_api_V0CommandRequest)

Response

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