> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Paylocity

> Integration details and setup guide for the Paylocity connector in Alloy Automation.

## Pre-Built Tooling

| Category                            | Details                                       |
| ----------------------------------- | --------------------------------------------- |
| **Authentication**                  | OAuth 2.0 (Client Credentials) + Bearer Token |
| **Two-Way Sync**                    | No                                            |
| **Events Supported**                | No                                            |
| **Realtime**                        | Polling                                       |
| **Supports Rate Limiting**          | Yes                                           |
| **Authentication Scopes Supported** | N/A (Client Credentials flow)                 |

***

## Objects Supported

Alloy Automation supports syncing the following objects from **Paylocity**:

* **Employees**
* **Employee Details**
* **Pay Rates**
* **Position Information**
* **Employment Status**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                                           |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **Offers free trial?**                             | No. Paylocity requires a paid subscription and partnership agreement. [Contact Paylocity](https://www.paylocity.com/contact-us/) |
| **Requires paid sandbox?**                         | Yes. You need to work with Paylocity to get sandbox environment access.                                                          |
| **Requires partnership to obtain authentication?** | Yes. You must be a Paylocity partner or customer to obtain API credentials.                                                      |

***

### Authentication (OAuth 2.0 Client Credentials)

For customers who want to completely whitelabel their authentication experience, you can provide your own developer keys instead of using Alloy Automation's.

<steps>
  <step title="Become a Paylocity Partner">
    Contact Paylocity to establish a partnership or ensure your organization has API access enabled on your Paylocity account
  </step>

  <step title="Request Developer Access">
    1. Visit the [Paylocity Developer Portal](https://developer.paylocity.com)
    2. Register for a developer account
    3. Request sandbox environment access from Paylocity
    4. Wait for approval (this can take several business days)
  </step>

  <step title="Create OAuth Application">
    1. Log in to the Paylocity Developer Portal
    2. Navigate to **API Credentials** or **Applications**
    3. Create a new OAuth application
    4. Note your **Client ID** and **Client Secret**
    5. Ensure you have your **Company ID** provided by Paylocity
  </step>

  <step title="Configure in Alloy Automation">
    1. In Alloy Automation, enter your Paylocity Client ID and Client Secret
    2. The system will use OAuth 2.0 Client Credentials flow to obtain access tokens
    3. Access tokens expire after 1 hour and will be automatically refreshed
    4. Test the connection with your Company ID to verify authentication
  </step>
</steps>

For detailed API documentation, visit [Paylocity API Documentation](https://developer.paylocity.com).

***

## Use Cases

### 1) HRIS data synchronization

Sync employee data from Paylocity to your internal HRIS, CRM, or data warehouse to maintain a single source of truth for employee information across your organization.

### 2) Onboarding automation

Automatically provision accounts, access, and resources for new employees by detecting new employee records in Paylocity and triggering downstream onboarding workflows.

### 3) Payroll integration

Pull employee pay rate and position data from Paylocity to integrate with expense management, project accounting, or time tracking systems for accurate cost allocation.

### 4) Compliance reporting

Extract employee status changes, pay rate updates, and position information from Paylocity to generate compliance reports for HR audits and regulatory requirements.

### 5) Workforce analytics

Aggregate employee data from Paylocity with other business metrics to analyze workforce trends, compensation patterns, and organizational structure for strategic planning.

***

## API Gotchas

* **Company ID requirement:** All API requests require a Company ID in the URL path. Make sure you have the correct Company ID for your organization before making API calls.

* **Token expiration:** Access tokens expire after 1 hour. Implement automatic token refresh logic to maintain uninterrupted API access for long-running processes.

* **Include parameters:** Many endpoints support an `include` query parameter to fetch related data (e.g., `include=info,position,payrate`). Use this to reduce the number of API calls needed to retrieve complete employee information.

* **Pagination:** The employee list endpoint supports pagination with `limit` and `nextToken` parameters. Implement proper pagination to retrieve all employees for large organizations.

* **Sandbox limitations:** The sandbox environment may have limited data and may not fully replicate production behavior. Test thoroughly in sandbox before moving to production.

> For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**.