Return a job

Returns an object describing the status of the queried job.

A queued job can have a COMPLETED, ERROR, FAILED, or CANCELLED status.

A COMPLETED status indicates that the queued job was completed and is ready for download.
An ERROR status indicates an error occurred during the job execution. The job will automatically re-run every 15 minutes for a maximum of 5 tries or until it succeeds (whichever comes first).
A FAILED status indicates that the job couldn’t be completed after 5 tries.
Only an impact.com system administrator can put a job into a CANCELLED state.

Important: Jobs shouldn’t have the FAILED and CANCELLED states. If your job results in either of these 2 statuses, reach out to your CSM (or contact support) to find out why.

Parameters

No parameters.

Example request

curl 'https://api.impact.com/Agencies/<AccountSID>/Jobs/<JobId>' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example response

{
  "Id": "37b0dfb-ba0c-404d-a78b-ff4b9b182c8b",
  "Type": "ApiReport",
  "ProgramId": "3629",
  "CreatedBy": "<AccountSID>",
  "CreatedDate": "2025-06-07T04:33:50-05:00",
  "StartedDate": "2025-06-07T04:33:50-05:00",
  "AbandonedDate": "2025-06-07T04:33:50-05:00",
  "CompletedDate": "2025-06-07T04:33:50-05:00",
  "CancelledDate": "2025-06-07T04:33:50-05:00",
  "FailedDate": "2025-06-07T04:33:50-05:00",
  "LastProgressUpdateDate": "2025-06-07T04:33:50-05:00",
  "Status": "COMPLETED",
  "StatusMessage": "Job processing completed successfully.",
  "RecordsProcessed": "250",
  "PercentageComplete": "100",
  "Replayable": "true",
  "ResultUri": "/Agencies/<AccountSID>/Jobs/37b0dfb-ba0c-404d-a78b-ff4b9b182c8b/Download"
}