GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference
These docs are for v2024-03-01. Click to read the latest docs for v2026-02-01.

Create a flow

post
https://api.gusto-demo.com/v1/companies//flows

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.

scope: flows:write

Path Params
string
required

The UUID of the company

Body Params
string
required

flow type

string

UUID of the target entity applicable to the flow. This field is optional for company flows, please refer to the flow_types table above for more details.

string
enum

the type of target entity applicable to the flow. This field is optional for company flows, please refer to the flow_types table above for more details.

Allowed:
Headers
string
enum
Defaults to 2024-03-01

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

Allowed:
Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Updated 5 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago