Skip to content

Get an Execution State

Check the current state of an execution you launched, using the jobExecutionId returned by Run a Job.


Endpoint

GET /job/api/jobs/executions/{jobExecutionId}
Requirement Value
Header X-API-Key: <your key>
Scope READ
Path param jobExecutionId — the ID returned when you launched the job

Example

curl https://<your-job-backend>/job/api/jobs/executions/1287 \
  -H "X-API-Key: amk_live_3f2a8b1c9d2e4f5a6b7c8d9e"

Response — 200 OK

{
  "jobExecutionId": 1287,
  "jobName": "qos-sms-test",
  "deviceId": "device-42",
  "deviceName": "Samsung A12",
  "execState": "EXECUTING",
  "launchedAt": "2026-06-27T14:32:10"
}
Field Type Description
jobExecutionId Long ID of the execution
jobName String The job that was launched
deviceId String Target device ID
deviceName String Target device name
execState String Current state (see below)
launchedAt DateTime When the execution was created

Execution states

State Meaning
PENDING Created, not yet picked up by the device
EXECUTING Running on the device
SUCCESS Finished successfully
FAILURE Finished with an error

Poll this endpoint until execState becomes SUCCESS or FAILURE (both are terminal).


Errors

Status code message Cause
403 J-802 Invalid API key Missing / unknown / revoked key
403 J-803 API key is expired The key's expiration date has passed
403 J-804 API key does not have the required permission The key has no READ scope
404 J-501 Job execution not found The jobExecutionId does not belong to you or does not exist

Example error body:

{
  "code": "J-804",
  "message": "API key does not have the required permission: READ",
  "status": 403
}