Skip to navigation
Thera APICompanyCompany

Generate Report

Generate a report for the company and return it as a file. The response carries the file bytes base64-encoded along with its filename and content type, so CSV and XLSX come back the same way.

Authentication

X-Thera-API-Keystring
API Key authentication via header

Path parameters

companyIdstringRequired

Query parameters

reportTypeenumRequired
Which report to generate.
Allowed values:
formatenumRequired
Output file format.
Allowed values:
includeTerminatedbooleanOptional
If true, include terminated employees. The Status column is always present in every row regardless of this flag.

Response

This endpoint returns an object.
filenamestring
contentTypestring
base64Contentstring

The report file bytes, base64-encoded. Decode to a Blob using contentType and download using filename.