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

# Ashby

> Read candidates, jobs, and applications from the Ashby ATS

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: Basic auth.
* **Connection**: HTTP Basic auth with `ASHBY_API_KEY` as the username and `ASHBY_API_PASSWORD` as the password.
* **Docs**: [https://developers.ashbyhq.com/docs/authentication](https://developers.ashbyhq.com/docs/authentication)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable             | Required | Description                                                                                                                                   |
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `ASHBY_API_KEY`      | Yes      | Ashby API key (used as the HTTP Basic username; the password is blank) [Docs](https://developers.ashbyhq.com/docs/authentication).            |
| `ASHBY_API_PASSWORD` | No       | Leave empty - Ashby Basic auth uses the API key as username with a blank password [Docs](https://developers.ashbyhq.com/docs/authentication). |

## Setup

1. **Sign in to Ashby**: Go to [https://app.ashbyhq.com](https://app.ashbyhq.com) and sign in as an organization admin. Ashby is a paid product - use your company workspace or request a sandbox from Ashby support.
2. **Create an API key**: Open Admin → API → API Keys and create a key. Grant read permissions for Candidates, Jobs, and Applications (plus candidate write if you will use Create Candidate).
3. **Set environment variables**: Add ASHBY\_API\_KEY=\<your key> to your .env. Leave ASHBY\_API\_PASSWORD unset or empty - Ashby uses the key as the Basic auth username with a blank password.
4. **Verify access**: Run List Jobs to confirm the key works.

* All Ashby endpoints are POST-based RPC calls (e.g. candidate.list) with JSON bodies; list/info/search calls do not modify data
* Authentication is HTTP Basic with the API key as username and an empty password
* Responses are wrapped as \{success, results, moreDataAvailable, nextCursor}; tools unwrap 'results'

Provider API reference: [https://developers.ashbyhq.com/reference](https://developers.ashbyhq.com/reference)

## Tools

| Tool              | Access | Description                                                                      |
| ----------------- | ------ | -------------------------------------------------------------------------------- |
| List Candidates   | Read   | List all candidates in the organization (read-only RPC via POST)                 |
| Get Candidate     | Read   | Get a candidate by ID (read-only RPC via POST)                                   |
| Search Candidates | Read   | Search candidates by email or name (read-only RPC via POST)                      |
| Create Candidate  | Write  | Create a new candidate                                                           |
| List Jobs         | Read   | List jobs, optionally filtered by status (read-only RPC via POST)                |
| List Applications | Read   | List applications, optionally filtered by job or status (read-only RPC via POST) |

## Example prompts

* List my open Ashby jobs and the active applications for each, grouped by stage.
* Search Ashby for a candidate by email and show their profile and applications.