GUgusto
Flows

Create a flow

Changed on

Generate a link to access a pre-built workflow in Gusto white-label UI. For security, all generated flows will expire within 1 hour of inactivity or 24 hours from creation time, whichever comes first.

You can see a list of all possible flow types in our Flow Types guide.

You can also mix and match flow_types in the same category to create custom flows suitable for your needs.

For instance, to create a custom onboarding flow that only includes add_addresses, add_employees, and sign_all_forms steps, simply stitch those flow_types together into a comma delimited string:

{
  "flow_type": "add_addresses,add_employees,sign_all_forms"
}

Please be mindful of data dependencies in each step to achieve the best user experience.

For more information and in-depth guides review the Getting Started guide for flows.

scope: flows:write

post/v1/companies/{company_uuid}/flows

Request

Path parameters

company_uuidstring required

The UUID of the company

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.

Request body

flow_typestring required

The type of flow to generate. Multiple flow types can be combined by separating them with commas (e.g., "add_addresses,add_employees,sign_all_forms").

entity_uuidstring

UUID of the target entity applicable to the flow. This field is optional for company flows.

entity_type'Company' | 'Employee' | 'Contractor' | 'Payroll'

The type of target entity applicable to the flow. This field is optional for company flows.

optionsobject

Optional configuration object that varies based on the flow_type. This can contain arbitrary key-value pairs specific to the flow being generated.

Example request

{
  "flow_type": "company_onboarding"
}

Response

Created

urlstring

Changes