PApaylocity
Client Onboarding

Get Client Onboardings

🚧 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.

get/compliance/v1/companies/b6001/clientOnboardings

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/compliance/v1/companies/b6001/clientOnboardings
  • Auth
    API key in header Authorization

Query parameters

filterstring

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

limitinteger

Limit.

offsetinteger

Offset.

Headers

testModeboolean

If true, all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

OK - Returns client onboardings.

countinteger

Optional total number of items available across all pages when requested.

offsetinteger

Zero-based index of the first item returned in the current page.

limitinteger

Maximum number of items requested per page.

Changes

No recorded changes to this operation across all 1 revision of this API.