---
title: "Create Worker Summary Report"
method: POST
path: "/reports/worker-summary"
---

# Create Worker Summary Report

`POST /reports/worker-summary`

Create a worker summary report.

## Request body

- object
  - `companyID` string, 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_workers` boolean — Determine whether the worker summary report returns terminated workers

## Response `200`

200

- object
  - `success` boolean
  - `data` object
    - `job_id` string
    - `status` string
    - `request_body` object
      - `companyID` string
      - `worker_type` string
      - `media_type` string
      - `active_workers` boolean
      - `has_live_key` boolean
      - `report_format` string
    - `created_at` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/zeal/apis/zeal-api.md) · [All operations](https://skmtc.net/zeal/apis/zeal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zeal/zeal-api/revisions/01346dceb27d/schema)