--- updatedAt: 2026-05-11T22:22:56.000Z agentTools: siteIndex: https://developer.paylocity.com/llms.txt projectIndex: https://developer.paylocity.com/integrations/llms.txt --- # 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](https://www.paylocity.com/contact/partner-form/) 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 # OpenAPI definition ```json { "openapi": "3.0.4", "info": { "title": "Background Check API", "version": "v1" }, "servers": [ { "url": "dc1demogwext.paylocity.com" } ], "paths": { "/compliance/v1/companies/{companyId}/businessUnits/{businessUnitId}": { "get": { "tags": [ "Business Unit" ], "summary": "Get Business Unit", "description": "> 🚧 Partner Restricted\n> 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](https://www.paylocity.com/contact/partner-form/) if you would like to discuss partnership opportunities.\n\n**Summary Description**\n\nThis endpoint returns a specific businessUnit for the companyId and businessUnitId\n\n**Use Cases**\n\n- Partner needs to confirm specific businessUnit details have been added into Paylocity for a given client", "x-explorer-enabled": false, "operationId": "ComplianceBusinessUnitGet", "parameters": [ { "name": "companyId", "in": "path", "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.\n **Allowable Values:**\n 9 char max", "required": true, "schema": { "type": "string" }, "example": "A12345" }, { "name": "businessUnitId", "in": "path", "description": "The Business Unit ID of the Business Unit.\n **Allowable Values:**\n 150 char max", "required": true, "schema": { "type": "string" }, "example": "BU-001" }, { "name": "testMode", "in": "header", "description": "If true all responses are mocked and generated randomly.", "schema": { "type": "boolean" }, "example": false }, { "name": "Authorization", "in": "header", "description": "Authorization token. Ex. Bearer ...", "required": true, "schema": { "type": "string" }, "example": "Bearer " } ], "responses": { "200": { "description": "Returns the business unit details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerBusinessUnitResponseDto" }, "examples": { "FinanceUnit": { "summary": "Active Finance business unit.", "value": { "businessUnitId": "BU-001", "businessUnitName": "Finance", "isActive": true, "description": "Finance department", "createdAt": "2025-11-11T10:00:00Z", "updatedAt": "2025-11-12T10:00:00Z" } }, "InactiveOperations": { "summary": "Inactive Operations business unit.", "value": { "businessUnitId": "BU-003", "businessUnitName": "Operations", "isActive": false, "description": "Operations team", "createdAt": "2025-11-11T10:00:00Z", "updatedAt": "2025-11-12T10:00:00Z" } } } } } }, "400": { "description": "Bad Request Error - Returns the details of the error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericErrorResponse" }, "examples": { "MissingRequiredField": { "summary": "A required field is missing in the request payload.", "value": { "correlationId": "bad-request-missing-field-correlation-id", "value": { "code": "INVALID_REQUEST", "message": "The request payload failed validation." }, "count": 1, "values": [ { "fields": "request.fieldName", "code": "INVALID_REQUEST", "message": "The request payload failed validation." } ] } }, "InvalidFieldFormat": { "summary": "A field in the request payload has an invalid format.", "value": { "correlationId": "bad-request-invalid-format-correlation-id", "value": { "code": "INVALID_REQUEST", "message": "The request payload failed validation." }, "count": 1, "values": [ { "fields": "request.otherField", "code": "INVALID_REQUEST", "message": "The request payload failed validation." } ] } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found - Business unit has not been found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericErrorResponse" }, "examples": { "ResourceNotFoundById": { "summary": "The resource with the specified numeric identifier was not found.", "value": { "correlationId": "not-found-by-id-correlation-id", "value": { "code": "RESOURCE_NOT_FOUND", "message": "The requested resource was not found." }, "count": 1, "values": [ { "fields": "resourceId", "code": "RESOURCE_NOT_FOUND", "message": "The requested resource was not found." } ] } }, "ResourceNotFoundByExternalKey": { "summary": "The resource with the specified external key was not found.", "value": { "correlationId": "not-found-by-external-key-correlation-id", "value": { "code": "RESOURCE_NOT_FOUND", "message": "The requested resource was not found." }, "count": 1, "values": [ { "fields": "externalKey", "code": "RESOURCE_NOT_FOUND", "message": "The requested resource was not found." } ] } } } } } }, "415": { "description": "Unsupported Media Type - Returns the details of the error" } } } } }, "components": { "schemas": { "ErrorDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error.", "nullable": true }, "message": { "type": "string", "description": "Descriptive message detailing the error.", "nullable": true } }, "additionalProperties": false }, "GenericErrorResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "description": "A unique identifier used for tracing and correlation purposes.", "nullable": true }, "value": { "$ref": "#/components/schemas/ErrorDto" }, "count": { "type": "integer", "description": "Gets the count of items in the Values list.", "format": "int32", "nullable": true, "readOnly": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "description": "A list of items.", "nullable": true } }, "additionalProperties": false }, "PartnerBusinessUnitResponseDto": { "type": "object", "properties": { "businessUnitId": { "type": "string", "description": "Business Unit ID associated with the business unit.", "nullable": true }, "businessUnitName": { "type": "string", "description": "Business Unit name.", "nullable": true }, "isActive": { "type": "boolean", "description": "A Boolean value indicating if the business unit is active." }, "description": { "type": "string", "description": "Description for the business unit.", "nullable": true }, "createdAt": { "type": "string", "description": "Creation timestamp for the business unit.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "Last update timestamp for the business unit.", "format": "date-time" } }, "additionalProperties": false, "description": "Business Unit response DTO for partner endpoints." }, "ValidationErrorDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error.", "nullable": true }, "message": { "type": "string", "description": "Descriptive message detailing the error.", "nullable": true }, "fields": { "type": "string", "description": "A string detailing the fields involved in the validation error.", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "CC JWT Authorization header using the bearer scheme", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [] } ] } ```