Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.
VariableRequiredDescription
ASHBY_API_KEYYesAshby API key (used as the HTTP Basic username; the password is blank) Docs.
ASHBY_API_PASSWORDNoLeave empty - Ashby Basic auth uses the API key as username with a blank password Docs.

Setup

  1. Sign in to Ashby: Go to 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

Tools

ToolAccessDescription
List CandidatesReadList all candidates in the organization (read-only RPC via POST)
Get CandidateReadGet a candidate by ID (read-only RPC via POST)
Search CandidatesReadSearch candidates by email or name (read-only RPC via POST)
Create CandidateWriteCreate a new candidate
List JobsReadList jobs, optionally filtered by status (read-only RPC via POST)
List ApplicationsReadList 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.