v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Reports

Get a report template

Get a company's report template. The only supported report type is payroll_journal. The resulting columns and groupings from this endpoint can be used as a guidance to create the report using the POST create report endpoint.

scope: company_reports:write

get/v1/companies/{company_uuid}/report_templates/{report_type}

Path parameters

company_uuidstring required

The UUID of the company

report_typestring required

The report type

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

OK

columnsstring[]

List of columns recommended

groupingsstring[]

List of groupings recommended

company_uuidstring

Company UUID

report_typestring

Type of report template