Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0755143347.0 KB
Sandbox

Create a new Sandbox Connection

Create a new connection (new company/provider pair) with a new account

post/sandbox/connections

Request body

provider_idstring required

The provider associated with the connection

authentication_type'api_token' | 'assisted' | 'credential' | 'oauth'
productsstring[]
employee_sizeinteger

Optional: the size of the employer to be created with this connection. Defaults to 20. Note that if this is higher than 100, historical payroll data will not be generated, and instead only one pay period will be created.

Response

OK

access_tokenstring required
account_idstring uuid required
authentication_type'api_token' | 'assisted' | 'credential' | 'oauth' required
company_idstring uuid nullable required
connection_idstring required
entity_idstring required
productsstring[] required
provider_idstring required
token_typestring required