Ashby
Arcade.dev tools for interacting with Ashby
0.1.0Ashby is an all-in-one recruiting platform. This toolkit lets Arcade agents read and write recruiting data in Ashby — candidates, applications, jobs, notes, feedback, and interview stage progression.
Capabilities
- Candidate management: Search candidates by name/email, retrieve full profiles (with application IDs), and add plain-text notes (e.g. agent handoffs or summaries).
- Application lifecycle: List applications filtered by job or status, move applications forward or backward through named interview stages, and read submitted feedback/scorecards.
- Job listings: Enumerate the organization's roles, optionally filtered by status.
- Debrief aggregation: Pull a candidate's profile, all notes, and all interview feedback across applications in a single call — no manual chaining required.
Secrets
-
ASHBY_API_KEY— An Ashby API key scoped to the permissions required by the tools you use. Generate one in your Ashby account under Settings → Integrations → API Keys. Each key carries granular permissions; the tools in this toolkit require the following depending on usage:- Candidates read — searching, reading profiles, listing notes, listing feedback, listing applications, debrief aggregation.
- Candidates write — adding notes, changing application stage.
- Interviews read — changing application stage (stage plan lookup).
- Jobs read — listing jobs.
Create and scope the key from the Ashby API Keys settings page. Note that Ashby API keys are organization-scoped; the key holder can read or write across all candidates and jobs in the org, so apply least-privilege scoping.
See the Arcade secrets guide for how to store secrets, or manage them directly at https://api.arcade.dev/dashboard/auth/secrets.
Available tools(9)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add a plain-text note to a candidate (e.g. an agent handoff or summary).
Creates a new note each time it runs. Requires the Candidates write permission
on the API key. | 1 | ||
Move an application to a named interview stage, in either direction.
Resolves the stage name to its id inside the application's own interview plan,
then moves the application — you do not look up stage ids yourself. Works to
advance or to move a candidate back; if the name does not match, the error lists
the plan's available stage names, and an ambiguous name (two stages share it)
errors rather than guessing. Records a transition each time it runs. It cannot
move an application into an archived/rejected stage (Ashby requires an archive
reason this tool does not collect). Requires the Candidates write and Interviews
read permissions on the API key. | 1 | ||
Get a candidate's profile and the ids of their applications.
Use the returned application ids with feedback or application tools; the Ashby
API does not list a candidate's applications directly. Requires the Candidates
read permission on the API key. | 1 | ||
Gather everything about a candidate for a debrief in one call.
Pulls the candidate's profile, the notes on file, and the interview feedback and
scorecards across each of their applications, then returns them together — you do
not chain the candidate, note, and feedback reads yourself. Feedback covers up to
the candidate's first applications when there are many; an application whose
feedback can't be read is counted in `feedback_failed` rather than failing the
whole call. Requires the Candidates read permission on the API key. | 1 | ||
Read the feedback and interview scorecards submitted on an application.
Useful for synthesizing what reviewers said about a candidate before a debrief.
Requires the Candidates read permission on the API key. | 1 | ||
List the organization's applications, optionally filtered by job and/or status.
The Ashby API does not filter applications by candidate; to find a specific
candidate's applications, read the candidate first and use its application ids.
Requires the Candidates read permission on the API key. | 1 | ||
Read the notes recorded on a candidate, paginated via the cursor.
Requires the Candidates read permission on the API key. | 1 | ||
List the organization's jobs (roles), optionally filtered by status.
A job is the role record; headcount slots ("openings") are a separate concept
not exposed here. Requires the Jobs read permission on the API key. | 1 | ||
Search the organization's candidates by name and/or email.
Intended for narrowing to a small set of known candidates (e.g. re-engaging a
past applicant). Returns at most 100 matches; provide at least one of name or
email, each at least 3 characters. Requires the Candidates read permission on
the API key. | 1 |