Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Business Unit

Get Company Business Units

🚧 Partner Restricted All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. Please reach out to our team if you would like to discuss partnership opportunities.

Summary Description

This endpoint returns all businessUnits for the companyId querying

Use Cases

  • Partner needs to confirm all businessUnits have been added into Paylocity for a client
  • Partner needs to confirm the status of businessUnits that have been added for a client
get/compliance/v1/companies/{companyId}/businessUnits

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

Query parameters

includeTotalCountboolean

If true it will add X-Pcty-Total-Count header with total count for this specific query.

offsetinteger

Pagination offset.

limitinteger

Pagination limit. Max value 100.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Returns the business units for the companyId

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.