api > thera > company > Company

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.

get/companies/{companyId}/reports

Request

  • Base URL: https://api.getthera.com
  • URL: https://api.getthera.com/companies/{companyId}/reports
  • Auth: API key in header X-Thera-API-Key

Path parameters

companyIdstring required

Query parameters

reportType'US_PAYROLL_EMPLOYEES' required

Catalog of self-serve / ops report types. New report types are added here over time.

Which report to generate.

format'CSV' | 'XLSX' required

Output formats a report can be generated in.

Output file format.

includeTerminatedboolean

If true, include terminated employees. The Status column is always present in every row regardless of this flag.

Response

Response with status 200

filenamestring required
contentTypestring required
base64Contentstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.