Skip to navigation
Background Check Client Onboarding

Get client onboardings

View as Markdown
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 Techpartnerships@paylocity.com

Summary Description

This endpoint allows partners to get their onboarded companies with an option of filtering by companyId and status.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired

Headers

testModebooleanOptional
If true, all responses are mocked and generated randomly.
AcceptstringOptional

Query parameters

filterstringOptional

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

limitintegerOptional
Limit.
offsetintegerOptional
Offset.

Response

Successful response