Jobs

Job status

get/jobs/{job_id}

Request

  • Base URL: https://api.scrupp.com/api/v1
  • URL: https://api.scrupp.com/api/v1/jobs/{job_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key
    • API key in query parameter api_key

Path parameters

job_idinteger required

Response

Current status

job_idinteger
status'queued' | 'running' | 'succeeded' | 'failed'
progressinteger nullable

Null when the job has no meaningful progress to report.

recordsinteger
retry_afterinteger
errorstring nullable
metadataobject nullable
result_urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.