Skip to content

Paylocity API Integration Connection

Paylocity is a cloud-based human capital management (HCM) platform that provides human resources and payroll management tools to help businesses manage core HR functions. In addition to the Data Extract method offered by Hire2Retire, we have implemented an API based approach to facilitate integration between Paylocity and Directory Services. API integration is user-friendly and allows for scheduled data retrieval, enabling daily or interval-based pulls of employee data reports.

Create a Connection

Paylocity API uses the Client Credentials mechanism for authentication. The following keys are required to authenticate:

  • Environment (Production or Sandbox) - Choose environment for the paylocity, by default 'No' is selected for production environment, select 'Yes' in case you have access to sandbox environment.

  • Client Id - This is the client id assigned to the registered application in the developer portal.

  • Client Secret - This is the secret assigned to the registered application in the developer portal.

  • Company Id - This is the Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.

Connection page

Figure 1. Paylocity API Connection Set Up page - Create Connection


Once you have successfully configured the connections, you can continue with the Design section to configure the rest of the workflow following these steps in order.

  1. HR Data Definition
  2. Lifecycle Business Rules
  3. Employment Status
  4. HR to AD Profile Map
  5. Organizational Unit Assignment - Only defined in on-premise Active Directory
  6. Security Group Assignment
  7. Distribution List Assignment


Once your workflow has been setup, you can optionally setup notifications and archival for your workflow.

Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow