> ## 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.

# Ashby setup

ConfigView reads your Ashby account through the Ashby API (`https://api.ashbyhq.com`), using an **API key** that an Ashby Organization Admin creates. Every Ashby endpoint is a `POST`, including reads, but ConfigView only calls `*.list` and `*.info` endpoints. It never creates, changes or deletes anything in Ashby.

You will end up with **1 required secret** (`ASHBY_API_KEY`) in ConfigView when setup is complete.

> **Scope of this integration today.** ConfigView reads who has an Ashby login and at which level (Organization Admin, Elevated Access, Limited Access, External Recruiter), whether each account is enabled, your departments and locations, every job with its status and hiring team, how many active applications sit in each interview stage of each job, the permissions the API key holds, and (when Ashby has turned it on for you) the audit log. **It never reads candidates.** No candidate name, email, phone, resume, note, scorecard, feedback, offer, source or demographic is collected or stored. Applications are only counted.

***

## What you need

* An Ashby account and someone with the **Organization Admin** role, who can create API keys
* Nothing to install

***

## Step 1: Open the Ashby page in ConfigView

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

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

***

## Step 2: Create a read-only API key

1. In Ashby open **Admin → Integrations → API Keys** and click **Create new API Key**
2. Name it `ConfigView`
3. Grant these permissions, **read only**:
   * **Organization**: Read (users, departments, locations)
   * **Jobs**: Read (jobs and hiring teams)
   * **Candidates**: Read. ConfigView uses this only because Ashby serves application lists under it; it reads each application's job, status and stage and counts them. Leave **access to private candidate fields** off.
   * **API Keys**: Read (shows the key's own permissions)
   * **Audit Logs**: Read, only if Ashby has enabled the audit log beta for you (see below)
4. Leave every **write** permission off, and leave **Allow acting on behalf of a user** off
5. Copy the key now. Ashby shows it only once.
6. In the ConfigView tab paste it into `ASHBY_API_KEY` under **Credentials** and click the save icon

***

## Step 3: 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 |
| - | - |
| **Users** | Everyone with a login, including deactivated users, with their role. |
| **Departments** and **Locations** | The org structure used for jobs. |
| **Jobs and Hiring Teams** | Every job and who is on its hiring team, by role. |
| **Application Counts** | Active applications per job and stage. Counts only. |
| **API Key** | The permissions on the key ConfigView uses. Skipped if Ashby has retired the endpoint. |
| **Audit Log** | Admin changes, kept as a history. Skipped unless the audit log beta is enabled for you. |

2. Click **Verify now**. The health check reads the secret, makes one authenticated call, then tries one small request for every area.

If a check fails:

* **The first check fails with 403.** The key is wrong, was deactivated, or was pasted with extra characters. Create a new one.
* **A core area fails with `missing_endpoint_permission`.** The key lacks that module's read permission. Add it in Ashby's API key page.
* **API key info or Audit log show as skipped.** Not an error: the key lacks the permission, Ashby has retired the endpoint, or the audit log beta is not enabled for your organization (ask Ashby to enable it).

***

## Data Tables

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

| Table | Source | Key Columns |
| - | - | - |
| `ashby_users` | `POST /user.list` | user\_id, first\_name, last\_name, email, global\_role, is\_enabled, manager\_id, updated\_at |
| `ashby_departments` | `POST /department.list` | department\_id, name, parent\_id, is\_archived |
| `ashby_locations` | `POST /location.list` | location\_id, name, location\_type, is\_remote, workplace\_type, country, region |
| `ashby_jobs` | `POST /job.list` | job\_id, title, status, department\_id, location\_id, hiring\_manager\_count, recruiter\_count, opened\_at, updated\_at, closed\_at |
| `ashby_job_hiring_team` | `POST /job.list` (`hiringTeam`) | job\_id, user\_id, email, team\_role |
| `ashby_application_counts` | `POST /application.list` | job\_id, stage\_title, stage\_type, application\_count, oldest\_created\_at, newest\_updated\_at |
| `ashby_api_key` | `POST /apiKey.info` | key\_title, created\_at, scopes, scope\_count |
| `ashby_audit_events` | `POST /auditLog.list` | event\_id, event\_time, actor\_email, category, target\_type, target\_id, ip\_address |

***

## Things worth knowing

**Deactivated users are collected on purpose.** `user.list` hides them unless asked; ConfigView asks, so you can see a leaver still named as hiring manager or recruiter on an open job.

**Roles.** `Organization Admin` manages users, API keys, webhooks and all jobs. `Elevated Access` and `Limited Access` see jobs and pipelines according to their hiring team membership. `External Recruiter` is meant for agencies; anyone outside your email domain with a different role is worth a look.

**Application counts are for active applications only.** Hired, archived and lead applications are not counted. Candidate names and details are never read into a row.

**Webhooks are not listed.** Ashby offers no endpoint that lists webhooks (only `webhook.info` for one known ID), so ConfigView cannot show which hosts your webhooks post to. The audit log, when available, records when webhooks are created or changed.

**The API key table shows only the calling key.** `apiKey.info` describes the key used for the request, so ConfigView cannot list other people's keys in your account. Ashby has also scheduled this endpoint for removal; if it disappears the collector simply skips.

**Rate limit.** Ashby does not publish a per-minute limit for these endpoints. ConfigView paces itself at 60 requests a minute (90 for application counts) and waits as long as Ashby asks after an HTTP 429. Lists are read 100 at a time.

## Known gaps (first run)

This integration was built from Ashby's published API reference without access to a live account. The first live run should be checked for: the exact request options of `user.list`, `department.list`, `location.list` and `job.list` (`includeDeactivated`, `includeArchived`, `status`, `limit`), whether `job.list` returns each job's `hiringTeam` filled in, the shape of `actor` and `target` in the audit log, and whether the audit log's `startDate` takes a date or a date-time.

## What isn't collected

* Candidates of any kind: names, emails, phones, resumes, notes, scorecards, feedback, sources, tags, EEOC and demographic data
* Offers and compensation, interview schedules and interviewer feedback
* The API key itself, signing secrets and webhook URLs
* Audit log event descriptions and changed-field values (free text that can name people)


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