# Paylocity API API

> Paylocity API API on Apizie: 30 endpoints (Get All Company Codes, Get All Custom Fields, Add new employee, Get all employees, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/finance:paylocity/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:paylocity`
- Category: Finance
- Status: byok
- Source: https://paylocity.com
- Page: https://www.apizie.tech/api/finance/paylocity
- OpenAPI: https://www.apizie.tech/api/finance/paylocity/openapi.json

For general questions and support of the API, contact: webservices@paylocity.com # Overview Paylocity Web Services API is an externally facing RESTful Internet protocol. The Paylocity API uses HTTP verbs and a RESTful…

## Endpoints

### Get All Company Codes
`GET https://www.apizie.tech/v1/finance:paylocity/get-all-company-codes-and-descriptions-by-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| codeResource | string | yes | Type of Company Code. Common values costcenter1, costcenter2, costcenter3, deductions, earnings, taxes, paygrade, positions. |

### Get All Custom Fields
`GET https://www.apizie.tech/v1/finance:paylocity/get-all-custom-fields-by-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| category | string | yes | Custom Fields Category |

### Add new employee
`POST https://www.apizie.tech/v1/finance:paylocity/add-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| body | object | yes | JSON request body |

### Get all employees
`GET https://www.apizie.tech/v1/finance:paylocity/get-all-employees` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| pagesize | integer | no | Number of records per page. Default value is 25. |
| pagenumber | integer | no | Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0. |
| includetotalcount | boolean | no | Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true. |

### Get employee
`GET https://www.apizie.tech/v1/finance:paylocity/get-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |

### Update employee
`POST https://www.apizie.tech/v1/finance:paylocity/update-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Add/update additional rates
`POST https://www.apizie.tech/v1/finance:paylocity/add-or-update-additional-rates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Add/update employee's benefit setup
`POST https://www.apizie.tech/v1/finance:paylocity/update-or-add-employee-benefit-setup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Get All Direct Deposit
`GET https://www.apizie.tech/v1/finance:paylocity/get-all-direct-deposit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |

### Get All Earnings
`GET https://www.apizie.tech/v1/finance:paylocity/get-all-earnings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |

### Add/Update Earning
`POST https://www.apizie.tech/v1/finance:paylocity/add-or-update-an-employee-earning` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Get Earnings by Earning Code
`GET https://www.apizie.tech/v1/finance:paylocity/get-earnings-by-earning-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| earningCode | string | yes | Earning Code |

### Get Earning by Earning Code and Start Date
`GET https://www.apizie.tech/v1/finance:paylocity/get-earning-by-earning-code-and-start-date` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| earningCode | string | yes | Earning Code |
| startDate | string | yes | Start Date |

### Delete Earning by Earning Code and Start Date
`POST https://www.apizie.tech/v1/finance:paylocity/delete-earning-by-earning-code-and-start-date` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| earningCode | string | yes | Earning Code |
| startDate | string | yes | Start Date |

### Add/update emergency contacts
`POST https://www.apizie.tech/v1/finance:paylocity/add-or-update-emergency-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Get all local taxes
`GET https://www.apizie.tech/v1/finance:paylocity/get-all-local-taxes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |

### Add new local tax
`POST https://www.apizie.tech/v1/finance:paylocity/add-local-tax` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Get local taxes by tax code
`GET https://www.apizie.tech/v1/finance:paylocity/get-local-tax-by-tax-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| taxCode | string | yes | Tax Code |

### Delete local tax by tax code
`POST https://www.apizie.tech/v1/finance:paylocity/delete-local-tax-by-tax-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| taxCode | string | yes | Tax Code |

### Add/update non-primary state tax
`POST https://www.apizie.tech/v1/finance:paylocity/add-or-update-non-primary-state-tax` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Get employee pay statement details data for the specified year.
`GET https://www.apizie.tech/v1/finance:paylocity/gets-employee-pay-statement-detail-data-based-on-the-specifi` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| year | string | yes | The year for which to retrieve pay statement data |
| pagesize | integer | no | Number of records per page. Default value is 25. |
| pagenumber | integer | no | Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0. |
| includetotalcount | boolean | no | Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true. |
| codegroup | string | no | Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips,… |

### Get employee pay statement details data for the specified year and check date.
`GET https://www.apizie.tech/v1/finance:paylocity/gets-employee-pay-statement-detail-data-based-on-the-specifi-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| year | string | yes | The year for which to retrieve pay statement data |
| checkDate | string | yes | The check date for which to retrieve pay statement data |
| pagesize | integer | no | Number of records per page. Default value is 25. |
| pagenumber | integer | no | Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0. |
| includetotalcount | boolean | no | Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true. |
| codegroup | string | no | Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips,… |

### Get employee pay statement summary data for the specified year.
`GET https://www.apizie.tech/v1/finance:paylocity/gets-employee-pay-statement-summary-data-based-on-the-specif` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| year | string | yes | The year for which to retrieve pay statement data |
| pagesize | integer | no | Number of records per page. Default value is 25. |
| pagenumber | integer | no | Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0. |
| includetotalcount | boolean | no | Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true. |
| codegroup | string | no | Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips,… |

### Get employee pay statement summary data for the specified year and check date.
`GET https://www.apizie.tech/v1/finance:paylocity/gets-employee-pay-statement-summary-data-based-on-the-specif-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| year | string | yes | The year for which to retrieve pay statement data |
| checkDate | string | yes | The check date for which to retrieve pay statement data |
| pagesize | integer | no | Number of records per page. Default value is 25. |
| pagenumber | integer | no | Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0. |
| includetotalcount | boolean | no | Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true. |
| codegroup | string | no | Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips,… |

### Add/update primary state tax
`POST https://www.apizie.tech/v1/finance:paylocity/add-or-update-primary-state-tax` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Get sensitive data
`GET https://www.apizie.tech/v1/finance:paylocity/get-sensitive-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |

### Add/update sensitive data
`POST https://www.apizie.tech/v1/finance:paylocity/add-or-update-sensitive-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| employeeId | string | yes | Employee Id |
| body | object | yes | JSON request body |

### Get Company-Specific Open API Documentation
`GET https://www.apizie.tech/v1/finance:paylocity/get-company-specific-open-api-documentation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |

### Obtain new client secret.
`POST https://www.apizie.tech/v1/finance:paylocity/add-client-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Add new employee to Web Link
`POST https://www.apizie.tech/v1/finance:paylocity/add-new-employee-to-web-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| companyId | string | yes | Company Id |
| body | object | yes | JSON request body |

## Example
```
curl "https://www.apizie.tech/v1/finance:paylocity/get-all-company-codes-and-descriptions-by-resource" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Paylocity API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/finance:paylocity/get-all-company-codes-and-descriptions-by-resource with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Paylocity API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Paylocity API itself also needs your own key from paylocity.com.

### Can AI agents use the Paylocity API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:paylocity.

### What is the status of the Paylocity API API?
Needs your own provider key (bring your own key)