v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Worker Summary Report

Create a worker summary report.

post/reports/worker-summary

Request body

companyIDstring required

Zeal Company ID

worker_type'employee' | 'contractor' required

Type of worker this report can be downloaded for. Accepted values are "employee" and "contractor".

media_type'csv' | 'pdf' required

The type of format this report can be downloaded as. Worker Summary Report currently support "csv" and "pdf".

active_workersboolean

Determine whether the worker summary report returns terminated workers

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "707ce36e-2267-2088-9fc4-c34d57c69c72",
    "status": "pending",
    "request_body": {
      "companyID": "24bsb29f07924840b119c34c1358940c",
      "worker_type": "employee",
      "media_type": "pdf",
      "active_workers": true,
      "has_live_key": true,
      "report_format": "worker_summary"
    },
    "created_at": "2023-12-29T18:21:28.951Z"
  }
}