Skip to main content
POST
Create Worker Summary Report

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

Zeal Company ID

worker_type
enum<string>
required

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

Available options:
employee,
contractor
media_type
enum<string>
required

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

Available options:
csv,
pdf
active_workers
boolean

Determine whether the worker summary report returns terminated workers

Response

200

success
boolean
default:true
Example:

true

data
object