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

Migrate company to embedded payroll

Migrate an existing Gusto customer to your embedded payroll product.

To use this endpoint, the customer will need to connect their Gusto account to your application using OAuth2 then view and accept the Embedded Payroll Terms of Service.

scope: partner_managed_companies:write

Path Params
string
required

The UUID of the company

Body Params
string
required

Email of the company signatory who is authorized to accept our Terms of Service and migration decision. You can retrieve the signatory email from the GET /v/1/companies/{company_id}/signatories endpoint.

string
required

The IP address of the signatory who viewed and accepted the Terms of Service.

string
required

The signatory's user ID on your platform.

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.

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