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

# Paylocity

> Paylocity Web Services API access for reading employees, earnings, company codes, and local taxes for a connected Paylocity company.

Paylocity Web Services API access for reading employees, earnings, company codes, and local taxes for a connected Paylocity company. Use when an agent needs employee records or pay data from Paylocity. Routes through Pipedream Connect, so Lava holds no Paylocity token.

4 example endpoints available through Lava's AI Gateway. See the [Paylocity API docs](https://developer.paylocity.com/integrations/reference/) for full documentation.

<Warning>This provider requires your own credentials — connect your API key or OAuth account before use.</Warning>

<Info>This is a **catch-all provider** — any valid URL under `https://api.paylocity.com` is supported. Paylocity Web Services API v2. Base [https://api.paylocity.com](https://api.paylocity.com) (Pipedream resolves the actual environment host, so send paths as-is). Company-scoped reads under /api/v2/companies/\{companyId}/: /employees (list), /employees/\{employeeId} (one), /employees/\{employeeId}/earnings, /codes/\{type} (company codes, e.g. /codes/department or /codes/location), /employees/\{employeeId}/localTaxes. companyId is the Paylocity company code, not a UUID. Date fields use MM/DD/YYYY, not ISO 8601. Auth is brokered by Pipedream (WebLinkAPI scope), do not send an Authorization header. This provider is read-only: only GET requests are supported. The endpoints below are curated examples.</Info>

## Endpoints

### List all employees for a company.

**GET** `https://api.paylocity.com/api/v2/companies/{companyId}/employees` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.paylocity.com/api/v2/companies/{companyId}/employees', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.paylocity.com%2Fapi%2Fv2%2Fcompanies%2F%7BcompanyId%7D%2Femployees" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### Get a single employee.

**GET** `https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.paylocity.com%2Fapi%2Fv2%2Fcompanies%2F%7BcompanyId%7D%2Femployees%2F%7BemployeeId%7D" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### Get an employee's earnings / pay records.

**GET** `https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.paylocity.com%2Fapi%2Fv2%2Fcompanies%2F%7BcompanyId%7D%2Femployees%2F%7BemployeeId%7D%2Fearnings" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### List company codes for a resource type (e.g. department, location, costCenter1).

**GET** `https://api.paylocity.com/api/v2/companies/{companyId}/codes/department` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://api.paylocity.com/api/v2/companies/{companyId}/codes/department', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Fapi.paylocity.com%2Fapi%2Fv2%2Fcompanies%2F%7BcompanyId%7D%2Fcodes%2Fdepartment" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

## Next Steps

<CardGroup cols={2}>
  <Card title="All Providers" icon="grid" href="/gateway/supported-providers">
    Browse all supported AI providers
  </Card>

  <Card title="Forward Proxy" icon="route" href="/gateway/forward-proxy">
    Learn how to construct proxy URLs and authenticate requests
  </Card>
</CardGroup>