commands_Command Request

Get a command request

Changed on

Retrieves a single command request by its ID.

Returns the full CommandRequest object, including the command type, its targeted devices or groups, the schedule used, and the arguments that were sent when the command was created.

About Get Command Request A command request represents the original call made to POST /commands/v0/commands/; it captures what was asked for (the command, its targets, and its schedule), while the actual execution outcome per device is tracked separately by Command Status records. Use this endpoint to re-inspect exactly what was requested, for example when auditing or troubleshooting a command that didn't behave as expected.

Common Use Cases

Reviewing the original arguments and targets of a command after it was issued

Confirming whether a command was scheduled or issued immediately

Best Practices

Pair this with GET /commands/v0/commands/{id}/stats/ to see the aggregate execution outcome alongside the original request details

Use the id returned from POST /commands/v0/commands/ rather than a device-level command status id, since these are different identifiers

Workflow

Capture the id returned when the command request was created

Call this endpoint to retrieve the full request detail

Call the stats endpoint for the same id to see aggregate execution status

get/commands/v0/commands/{id}/

Request

  • Base URL
    https://develop-api.esper.cloud/api
  • URL
    https://develop-api.esper.cloud/api/commands/v0/commands/{id}/
  • Auth
    HTTP bearer

Path parameters

idstring required

ID of the command request object

Response

Command request information

codeinteger
messagestring

Changes

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      removed subschema #1 subschema #2 from the // response property oneOf list for the response status