v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Terminal actions - company level

Get terminal action

Returns the details of the terminal action identified in the path. To make this request, your API credential must have one of the following roles:

  • Management API—Terminal actions read
  • Management API—Terminal actions read and write

In the live environment, requests to this endpoint are subject to rate limits.

get/companies/{companyId}/terminalActions/{actionId}

Path parameters

companyIdstring required

The unique identifier of the company account.

actionIdstring required

The unique identifier of the terminal action.

Response

OK - the request has succeeded.

actionTypestring

The type of terminal action: InstallAndroidApp, UninstallAndroidApp, InstallAndroidCertificate, or UninstallAndroidCertificate.

configstring

Technical information about the terminal action.

confirmedAtstring date-time

The date and time when the action was carried out.

idstring

The unique ID of the terminal action.

resultstring

The result message for the action.

scheduledAtstring date-time

The date and time when the action was scheduled to happen.

statusstring

The status of the terminal action: pending, successful, failed, cancelled, or tryLater.

terminalIdstring

The unique ID of the terminal that the action applies to.