v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Generated Documents

Get a generated document

Get a document given the request_uuid. The response will include the generation request's status and urls to the document. A list of urls is returned as certain document types require several urls.

scope: generated_documents:read

get/v1/generated_documents/{document_type}/{request_uuid}

Path parameters

document_type'printable_payroll_checks' required

The type of document being generated

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

Example response

request_uuidstring

A unique identifier of the Generated Document request

status'pending' | 'started' | 'succeeded' | 'failed'

Current status of the Generated Document

document_urlsstring[]

The array of urls to access the documents.