> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/paylocity-integration-setup.md).

# Paylocity Integration Setup

### Getting started

BalkanID recommends a dedicated API application in Paylocity CoreHR. Do not use personal-account credentials.

#### Requirements

Collect these values before you begin:

* **Client ID**
* **Client Secret**
* **Company ID**
* **Environment** — Production or Demo/Sandbox

{% hint style="info" %}
This integration syncs **employee records only**. Paylocity's public CoreHR API does not expose authorization or entitlement data. BalkanID does not extract roles, groups, or access relationships.
{% endhint %}

#### Obtain your CoreHR API credentials

Paylocity issues CoreHR API credentials through your implementation or account team. Credentials are scoped to a Company ID.

Ask your team to register a CoreHR API application for BalkanID. Confirm whether the credentials are for Production or Demo/Sandbox.

### Configure Paylocity within your BalkanID tenant

1. Sign in to BalkanID. Switch to the tenant where you want the integration.
2. Go to *Integrations* → **Add Integration**. Search for and select **Paylocity**.
3. Set the **Primary Application Owner**. Add a description and secondary owners if needed.
4. Under **Select Extraction Type**, keep **Direct Configuration** selected. Enter the **Client ID**, **Client Secret**, **Company ID**, and **Environment**. Then click **Next**.
5. Complete **Optional Configuration**, if required.
6. Click **Save**. BalkanID displays the integration with the others on the **Integrations** page. When data is available, its status is **Connected** and its message is **Data available**.

### What BalkanID extracts

| Type          | From Paylocity                                                                                                          |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **Employees** | Every employee record, including name, work email, job title, hire date, employment status, work location, and manager. |

{% hint style="warning" %}
This integration never requests or stores sensitive fields. These include SSN, birth date, gender, ethnicity, marital status, home address, and pay rate.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/paylocity-integration-setup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.