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 in exploring partnership opportunities, please contact us at [email protected]

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.

Query Params
string

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

int32
Defaults to 50

Limit.

int32
Defaults to 0

Offset.

boolean
Defaults to false

Include total items count into response as a header.

Headers
boolean
Defaults to false

If true all responses are mocked and generated randomly.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json