added
Custom Report APIs & Flows
7 months ago by Gusto Developer Relations
Added the Reports endpoints and reports
flow and to create custom reports for a company using custom columns, groupings, and optional filters.
- Create a custom report endpoint - Create a custom report for a company. This endpoint initiates creating a custom report with custom columns, groupings, and filters. The
request_uuid
in the response can then be used to poll for the status and report URL upon completion using the report GET endpoint. - Get a report endpoint - Get a company's report given the
request_uuid
. The response will include the report request's status and, if complete, the report URL. - Get a report template endpoint - 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. reports
flow - Generate a reports flow via API call to our Flows endpoint:
cURL
curl --request POST
--url <https://api.gusto-demo.com/v1/companies/{{company_uuid}}/flows>
--header 'Authorization: Bearer {{access_token}}’'
--header 'Content-Type: application/json'
--data ' { "flow_type": "reports" }'
Review our Generate Custom Reports guide for more info.