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

# Setting Up an API HR Integration

> Step-by-step guide to creating a JobTicket+ API Integration from the HR Integration portal.

The **JobTicket+ API Integration** lets you programmatically push your employee roster to JobTicket via the [Trigger HR Sync](/v1/endpoint/hr-integrations-sync) endpoint. Follow the steps below to create one from the portal.

<Note>
  Setting up an HR Integration requires admin access to your company's
  JobTicket+ portal.
</Note>

## Steps

### 1. Open HR Integration

In the left sidebar, under **Employee Onboarding**, click **HR Integration**.

You will land on the HR Integration page, which shows the carousel of supported HR systems at the top and a list of your currently configured integrations below.

***

### 2. Start a New Integration

Click the **Integrate New HR System** button in the top-right of the **HR Systems Integrated** section.

<Warning>
  A usage notice will appear before the selection dialog opens:

  > *"Usage of HR integration incurs an addition of 1 EUR per linked employee. This cost is regardless of how many HR systems you integrate."*

  Click **I Understand** to proceed, or **Cancel** to abort.
</Warning>

***

### 3. Select the API Integration Type

A **"Select HR system to integrate"** dialog opens with a search field.

1. Type **`api`** in the search box.

2. The result **JobTicket+ API Integration** will appear, showing its available features:

   | Feature                    | Description                                   |
   | -------------------------- | --------------------------------------------- |
   | Sync Employees             | Push your full employee roster via API        |
   | Sync Company Employee ID   | Map your internal HR IDs to JobTicket records |
   | Pause/Resume Subscriptions | Control subscription state per employee       |
   | Use HR Custom Fields       | Drive eligibility logic from custom HR fields |

3. Click the entry to select it (a checkmark will appear on its icon).

***

### 4. Start the Integration

Click **Start Integration** at the bottom of the dialog.

JobTicket+ will create the integration and assign it a unique **Integration ID**. You will be returned to the HR Integration page where your new integration is listed with status **INITIAL SYNC PENDING** once it becomes active.

***

### 5. Note Your Integration ID

On the HR Integration page, locate your new integration card. The **Integration ID** shown there is the `{id}` path parameter you will use in all API calls, for example:

```
POST /hr-integrations/{id}/sync
```

Retrieve it programmatically at any time via [List HR Integrations](/v1/endpoint/hr-integrations-list).

***

### 6. Configure (Optional)

Click **Configure** on the integration card to adjust sync settings, field mappings, or subscription rules for your integration.

***

## Next Steps

With the integration created, you can begin pushing employee data using the [Trigger HR Sync](/v1/endpoint/hr-integrations-sync) endpoint. Make sure to include your full active employee roster in every sync call — any employee omitted will be offboarded.