Guides

Retrieve a list of incidents for the organization.

Authorization

This endpoint requires Authorization.

Request

JSON Object containing the following parameters:

KeyTypeRequiredDescription
namestringThis or friendly_name
friendly_namestringThis or name
file_idstringNoUnique ID of a file to attached to the command
extra_paramsobjectNoParameters to pass to the command

Response

Return an array of all commands matching the query, with each having the following information:

KeyTypeDescription
idstringUnique identifier of the command.
statusstring"pending"
namestringCommand name
friendly_namestringCustomer facing friendly command name
paramsobjectOptional command parameters
messagestringMessage returned by the device
device_idstringUnique identifier of the device.
created_atstringDate and time when the command was created in ISO 8601 format (e.g., "2024-07-17T07:09:26Z").
scheduled_atstringDate and time when the command was scheduled to run in ISO 8601 format (e.g., "2024-07-17T07:10:27Z").
issuer_namestringName of the user scheduling the command (if available)
Language
Authorization
Header
Click Try It! to start a request and see the response here!