GUgusto
Reports

Get a report

Get a company's report given the request_uuid. The response will include the report request's status and, if complete, the report URL.

Reports containing PHI are inaccessible with company_reports:read:tier_2_only data scope

scope: company_reports:read

get/v1/reports/{request_uuid}

Request

Path parameters

request_uuidstring required

The UUID of the request to generate a document. Generate document endpoints return request_uuids to be used with the GET generated document endpoint.

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

request_uuidstring

A unique identifier of the report request

statusstring

Current status of the report, possible values are 'succeeded', 'pending', or 'failed'

report_urlsstring[]

The array of urls to access the report

Changes

No recorded changes to this operation across all 2 revisions of this API.