---
title: "Connect CharlieHR to Rig — Rig guide"
description: "Connect CharlieHR to Rig with an API key. Sync team members, teams, offices, leave and allowances into your warehouse. Salary data is never synced."
canonical: "https://rig.so/guides/connect-charliehr"
format: markdown
---

Search guides, references, playbooks…⌘K

Browse guides

# Connect CharlieHR to Rig

CharlieHR is an HR system for small businesses. Rig syncs your people directory, leave requests and allowances into your warehouse, so headcount and absence questions sit beside the rest of your data. Salaries and bank details are never synced, and personal details are off until you switch them on.

## Before you start

- Only a CharlieHR **Super Admin** can create API keys.
- Decide whether any personal fields should be synced. They are all off by default, and you can switch them on for each field when you pick streams.

## Step 1: Generate a CharlieHR API key

1. Sign in to CharlieHR as a Super Admin and go to **Company \> Integrations**.
2. Open the **API Keys** tab at the top of the page.
3. In the **V3** section, click **Generate Keys** and give the key a clear title, such as Rig.
4. Choose the access level. **Admin view** leaves salary data out of the share, and **Super Admin view** includes it. Rig never syncs salaries either way, so Admin view is the narrower choice.
5. Choose **read only**.
6. Copy the Client ID and Client Secret. CharlieHR does not store them for you, so keep both safe.

Regenerate if lost
CharlieHR shows the secret once, at creation. If you lose it, regenerate the key and update Rig.

## Step 2: Connect it in Rig

New to Rig? Watch how to find Connections

Adding a source needs a workspace owner, or a role with the Manage connections permission, on a workspace where you manage your own connections. If the Connectors tab says “Data ingestion for this workspace is managed by Rig”, ask an owner or Rig support to add the source.

1. In Rig, open `Connections`, choose the `Connectors` tab and go to `Sources & actions`.
2. Search for **CharlieHR**, open the card and click `Connect`.
3. **Client ID**: The Client ID from the key.
4. **Client Secret**: The Client Secret from the same key.
5. Click `Continue`. Rig checks the credentials and lists the streams it can reach, so choose the ones you want and click `Connect`.
6. The source then syncs on its schedule, which is nightly unless you change it. To load data straight away, click `Sync` on its row; `Test` pulls a small sample first if you want to check the connection.

## What Rig pulls in

CharlieHR lands in its own `charliehr` schema in your warehouse:

- **Company and structure**: company details, offices and teams.
- **People**: team members, with the work-related profile fields on by default.
- **Leave**: leave requests, leave types and leave allowances.
- **Calendar**: company holidays and restricted dates.

Salaries, bank details, National Insurance and tax fields, and HR notes are never synced and cannot be switched on. Personal contact details, address, date of birth and the reason typed on a leave request are off by default and can be enabled one field at a time.

## Good to know

- CharlieHR has no filter for recent changes, so every stream is read in full each sync. An HR system is a few hundred rows, so this is quick.
- Company holidays and restricted dates have no id, so Rig matches them on name and start date. A renamed holiday lands as a new row beside the old one, and a Full resync clears the old row.
- Leave and allowance amounts are stored as decimals, so half days appear correctly.
- To disconnect CharlieHR, click the bin icon on the source's row under `Sources & actions`. Only whoever connected the source or a workspace owner can do this, and data already synced stays in the warehouse.

## What people use this for

- Report headcount by team and office
- Understand absence and leave
- Track leave allowances

[More ideas for using CharlieHR](https://rig.so/integrations/charliehr)

## CharlieHR documentation

- [CharlieHR: integrate with unlisted platforms](https://help.charliehr.com/en/articles/9579162-integrate-charlie-with-unlisted-platforms)

Was this guide helpful?

Yes No

---

- [This page as HTML](https://rig.so/guides/connect-charliehr)
- [Site map for language models](https://rig.so/llms.txt)
- [API and agent documentation](https://rig.so/developers)