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

# Recruitee setup

Configview reads your Recruitee account through the Recruitee ATS API (`https://api.recruitee.com/c/{company_id}`), using a **personal API token** that someone in Recruitee creates. Configview sends only `GET` requests. It never creates, changes or deletes anything in Recruitee.

You will end up with **2 required secrets** (`RECRUITEE_API_TOKEN`, `RECRUITEE_COMPANY_ID`) in Configview when setup is complete.

> **Scope of this integration today.** Configview reads who has a Recruitee account and in which role, the permission roles and what they allow, your job offers (status, department, location, hiring manager, recruiter and hiring team, dates), departments and locations, and **counts** of candidates per job and pipeline stage. It also keeps a running history of the account's audit log. It does **not** read or store candidate names, emails, phone numbers, CVs, notes, ratings, evaluations, messages or interview content: candidates are only counted. Street addresses of locations are not stored.

***

## Read this first: Recruitee tokens cannot be narrowed

A Recruitee personal API token has **exactly the permissions of the user who created it**. There are no scopes and no read-only tokens, and an admin cannot restrict a token's access level. Anyone who gets hold of the token could, in principle, do what that user can do, even though Configview itself only ever reads.

What you can do about it:

* Create the token from a **dedicated user** (for example `configview@yourcompany.com`) rather than from a person's account, so it does not stop working when someone leaves.
* Give that user the **lowest role that still lets everything below work**. Recruitee does not publish which role each endpoint needs, so start with a role that can see all jobs, candidates and the team, and use **Verify now** (step 4). If a check says an area is not available, it needs a higher role; decide whether you want it.
* A token does not expire on its own. It stops working when the user is removed or the token is revoked, so note who owns it.

***

## What you need

* A Recruitee account with API access, and someone who can add a user and open **Settings → Apps and plugins**
* Your **company ID** (a number)

***

## Step 1: Open the Recruitee page in Configview

Open Configview in a second browser tab and leave it open:

`https://{companyname}.configview.com/admin/integrations/recruitee`

***

## Step 2: Create the token

1. In Recruitee add the dedicated user with the role you chose above and sign in as that user.
2. Open **Settings → Apps and plugins → Personal API tokens** and create a new token named `Configview`.
3. Copy the token now. Recruitee shows it only once.
4. In the Configview tab paste it into `RECRUITEE_API_TOKEN` under **Credentials** and click the save icon.

***

## Step 3: Add the company ID

1. The company ID is the number in the API path `/c/<id>/`. Recruitee's Getting Started guide shows where to find it; the company subdomain (the name before `.recruitee.com`) also works in API paths.
2. Paste it into `RECRUITEE_COMPANY_ID` in Configview and click the save icon.

***

## Step 4: Connect and verify

1. Click **Connect**. Configview creates its tables and schedules every collector at your default run time. Stop any you don't want under **Collectors**:

| Script | Notes |
| - | - |
| **Admins and Roles** | Every account with its role, disabled flag, two-factor and last sign-in when returned, and the permission roles. |
| **Departments and Locations** | Departments and offices with how many jobs use each. |
| **Job Offers** | Every job and talent pool with status, owner fields and hiring team. |
| **Candidates per Stage** | Counts of candidates per job and stage. Pages through all candidates, 100 per request, and keeps only counts and dates. |
| **Audit Events** | The audit log, kept as a history. Skipped if the token's user cannot read it. |

2. Click **Verify now**. The health check reads both secrets, calls `GET /c/{id}/admin`, then tries one small request for every area.

If a check fails:

* **api\_token fails with 401.** The token is wrong, was revoked, or belongs to a different company. Create a new one.
* **api\_token fails with 404.** The company ID is wrong.
* **Admins, offers, departments, locations or candidates fail with 403.** The token's user has a role that cannot read that area. Give the user a higher role, or accept the gap.
* **Roles, pipeline templates or the audit log show as skipped.** The user's role or your plan does not include them. Nothing to fix unless you want that area.

***

## Data Tables

Once the scripts run, these tables are created in your database. Each table has a `run_at` column. Every table except `recruitee_audit_events` keeps only the newest run; `recruitee_audit_events` keeps its history.

| Table | Source | Key Columns |
| - | - | - |
| `recruitee_admins` | `GET /c/{id}/admins` | admin\_id, name, email, role, disabled, two\_factor\_enabled, created\_at, last\_sign\_in\_at |
| `recruitee_roles` | `GET /c/{id}/roles` | role\_id, name, is\_system, admins\_count, abilities |
| `recruitee_departments` | `GET /c/{id}/departments` | department\_id, name, offers\_count |
| `recruitee_locations` | `GET /c/{id}/locations` | location\_id, name, city, country\_code, active\_offers\_count, archived\_at |
| `recruitee_offers` | `GET /c/{id}/offers` | offer\_id, title, kind, status, department, hiring\_manager\_id, recruiter\_id, team\_size, candidates\_count, published\_at |
| `recruitee_offer_team` | `GET /c/{id}/offers` | offer\_id, admin\_id, team\_role |
| `recruitee_stage_counts` | `GET /c/{id}/candidates`, `GET /c/{id}/pipeline_templates` | offer\_id, stage\_id, stage\_name, candidate\_count, disqualified\_count, oldest\_created\_at |
| `recruitee_audit_events` | `GET /c/{id}/audit_log` | event\_id, created\_at, action, actor\_admin\_id, target\_type, target\_id, ip\_address |

***

## Rate limits

Recruitee documents **1000 requests per minute per API token**. Configview paces itself to 240 a minute, waits out a `429` using `Retry-After`, and retries server errors. The candidate tally is the only large job: one request per 100 candidates.

***

## Known gaps

* **Webhooks and integrations.** Recruitee's published reference does not document a way to list webhook endpoints or installed integrations, so Configview does not collect them. Review them under **Settings → Apps and plugins**.
* **Single sign-on and two-factor settings.** No company security settings endpoint is documented. Two-factor per account is read only if the admin record carries it.
* **API token inventory.** There is no documented way to list personal API tokens, so their owners and last use are not visible.
* **Field names.** The admins, roles, offers and audit log response fields are not fully published. The collectors accept several likely names; the first run on a live account should be checked for empty columns (for example last sign-in or hiring manager).

***

## Things worth knowing

**Accounts outside your email domain.** Agencies and freelance recruiters often have Recruitee accounts on their own domain. They can see candidate data and sit outside your offboarding process.

**Jobs with nobody responsible.** A published job with no hiring manager, or whose recruiter account is disabled, collects applications that nobody owns.

**Stage counts are counts.** `recruitee_stage_counts` never contains a candidate. If a count looks off, remember archived and disqualified candidates may be included depending on how Recruitee returns them.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.