PApaylocity
Business Unit

Get Business Unit

🚧 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 a specific businessUnit for the companyId and businessUnitId

Use Cases

  • Partner needs to confirm specific businessUnit details have been added into Paylocity for a given client
get/compliance/v1/companies/{companyId}/businessUnits/{businessUnitId}

Request

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

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

businessUnitIdstring required

The Business Unit ID of the Business Unit. Allowable Values: 150 char max

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Returns the business unit details

businessUnitIdstring nullable

Business Unit ID associated with the business unit.

businessUnitNamestring nullable

Business Unit name.

isActiveboolean

A Boolean value indicating if the business unit is active.

descriptionstring nullable

Description for the business unit.

createdAtstring date-time

Creation timestamp for the business unit.

updatedAtstring date-time

Last update timestamp for the business unit.

Changes

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