v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Client Onboarding

Get Onboarding Status

🚧 Partner Restricted

The Partner Onboarding API is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, please reach out to our team to discuss partnership opportunities.

Summary Description

The new Partner Onboarding API is designed to enable our partners to onboard customers through our Paylocity Marketplace-initiated workflow. Approved partners will utilize the API to provision a client onto a specific integration. This endpoint allows partners to get their onboardings with an option of filtering by companyId and status.

get/apiHub/security/v1/companies/b6001/clientOnboardings

Query parameters

filterstring

The filtering expression ( e.g. companyId eq b6001, status eq Approved ).

limitinteger

Limit.

offsetinteger

Offset.

includeTotalCountboolean

Include total items count into response as a header.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Response

OK - Returns client onboardings.

totalCountinteger nullable