v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Get Job Status

Get status for a job.

get/reports

Query parameters

job_idstring required

Job ID returned in the POST response for whatever report was created.

companyIDstring required

Zeal Company ID

Request body

{"stackTrail":"paths:/reports:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "7g88a4e0-f2a0-4dc0-9a1c-215e083de5eb",
    "status": "complete",
    "created_at": "2023-12-25T18:52:43.138Z",
    "request_body": {
      "start_date": "2023-12-01",
      "end_date": "2023-12-09",
      "company_id": "fc235f012bae46aa8a082f357715bcfa",
      "media_type": "csv",
      "has_live_key": true,
      "report_format": "payroll_journal"
    },
    "payload": "https://api.zeal.com/reports/downloads/7g88a4e0-f2a0-4dc0-9a1c-215e083de5eb"
  }
}