# Ashby integration

> Applicant tracking system API for managing candidates, jobs, applications, interviews, offers, and hiring workflows.

- Authentication: apiKey

## Tools (160)

- **Add Application Hiring Team Member**: Add a user to the hiring team of a specific application.
- **Add Candidate Email Message**: Record an email conversation between a user and a candidate.
- **Add Candidate Tag**: Add an existing tag to a candidate for categorization and filtering.
- **Add Candidate to Project**: Add an existing candidate to a project.
- **Add Completed Assessment to Candidate**: Attach a completed partner assessment result to a candidate.
- **Add Hiring Team Member**: Add a user to the hiring team of a job.
- **Add Job to Opening**: Adds a job to an existing opening.
- **Add Location to Opening**: Adds a location to an opening.
- **Add User to Interviewer Pool**: Add a user to an interviewer pool.
- **Anonymize Candidate**: Anonymize a candidate by scrubbing PII fields.
- **Approve Offer**: Approves an offer or a specific approval step within an offer's approval process.
- **Archive Candidate Tag**: Archive a candidate tag so it can no longer be applied.
- **Archive Department**: Archive a department so it is no longer active.
- **Archive Interviewer Pool**: Archive an interviewer pool.
- **Archive Location**: Archive an office location.
- **Cancel Assessment**: Cancel a started assessment (called by Ashby, implemented by partner).
- **Cancel Interview Schedule**: Cancel a scheduled interview.
- **Change Application Source**: Change the source attributed to an application.
- **Change Application Stage**: Move an application to a different interview stage in the hiring pipeline.
- **Create Application**: Create a new job application by associating a candidate with a job in the hiring pipeline.
- **Create Candidate**: Create a new candidate with contact information and social profiles.
- **Create Candidate Note**: Add a note to a candidate's profile with plain text or HTML content.
- **Create Candidate Tag**: Create a new candidate tag for the organization.
- **Create Custom Field**: Create a custom field on a supported object (Candidate, Job, etc.).
- **Create Department**: Create a new department in the org hierarchy.
- **Create File Upload Handle**: Obtain a handle used to upload a file that will be attached to an object.
- **Create Interviewer Pool**: Create a new interviewer pool.
- **Create Interview Schedule**: Create a scheduled interview with events and interviewers for an application.
- **Create Job**: Create a new job with a title, department, and location.
- **Create Location**: Creates a new location or location hierarchy in Ashby.
- **Create Offer**: Creates a new offer within an offer process using the associated offer form.
- **Create Opening**: Creates a new opening (headcount) with optional jobs, locations, and target dates.
- **Create Referral**: Creates a new employee referral with the specified referral form and credited user.
- **Create Survey Request**: Creates a survey request for a candidate and returns a survey URL to share.
- **Create Survey Submission**: Creates a new survey submission with the candidate's answers.
- **Create User Interviewer Pause**: Pauses a user from being scheduled as an interviewer, optionally with start/end dates and a comment.
- **Create Webhook**: Creates a webhook subscription for various Ashby events. Requires apiKeysWrite scope.
- **Delete User Interviewer Pause**: Deletes an interviewer pause by id.
- **Delete Webhook**: Deletes a webhook subscription by id.
- **Generate Report**: Asynchronously generates a report (beta); call without requestId to start then poll with requestId.
- **Generate Synchronous Report**: Retrieves report data synchronously (beta, 30s timeout). Use report.generate for long-running reports.
- **Get API Key Info**: Retrieve information about the API key being used to make the request.
- **Get Application Info**: Retrieve detailed information about a specific application by ID.
- **Get Candidate Info**: Retrieve detailed information about a specific candidate by ID.
- **Get Custom Field Info**: Retrieve the definition of a specific custom field by id.
- **Get Department Info**: Retrieve information about a specific department.
- **Get Feedback Form Definition Info**: Retrieve a feedback form definition including its fields.
- **Get File Info**: Retrieve info for an uploaded file including a download URL.
- **Get Interviewer Pool Info**: Retrieve a specific interviewer pool by id.
- **Get Interview Info**: Retrieve a specific interview definition (stage-level) by id.
- **Get Interview Stage Info**: Retrieve a specific interview stage by id.
- **Get Job Info**: Retrieve detailed information about a specific job by its ID.
- **Get Job Interview Plan Info**: Retrieve the interview plan assigned to a specific job.
- **Get Job Posting Info**: Retrieve details about a specific job posting.
- **Get Location Info**: Retrieves details about a specific location by id.
- **Get Notetaker Transcript Info**: Fetches metadata and a pre-signed download URL for an AI Notetaker transcript recording (early access).
- **Get Offer Info**: Returns details about a single offer by id.
- **Get Opening Info**: Retrieves an opening by its UUID.
- **Get Project Info**: Retrieves a project by its UUID.
- **Get Referral Form Info**: Fetches the default referral form, creating one if none exists.
- **Get Survey Form Definition Info**: Returns details about a single survey form definition by id.
- **Get User Info**: Retrieves details about an Ashby user by id.
- **Get User Interviewer Settings**: Retrieves the interviewer settings for a user.
- **Get Webhook Info**: Retrieves information about a specific webhook by its id.
- **List Application Criteria Evaluations**: List AI recruiter criteria evaluations for a given application.
- **List Application Feedback**: List feedback submissions for a specific application.
- **List Application Hiring Team Roles**: List the roles available on application hiring teams.
- **List Application History**: List the history of stage changes and events for an application.
- **List Applications**: Retrieve a paginated list of job applications with filtering by job, status, and date.
- **List Approvals**: List approvals for jobs, offers, and openings.
- **List Archive Reasons**: List all available reasons for archiving applications.
- **List Assessment Custom Fields**: List custom fields a partner assessment can sync into Ashby.
- **List Assessments**: List assessment types a partner offers (called by Ashby).
- **List Brands**: List the brands configured for the organization.
- **List Candidate Client Info**: List per-candidate client-specific info fields.
- **List Candidate Fraud Checks**: List AI-driven fraud-check results for a candidate.
- **List Candidate Notes**: List notes attached to a specific candidate.
- **List Candidate Projects**: List projects a candidate has been added to.
- **List Candidates**: Retrieve a paginated list of all candidates with optional incremental sync support.
- **List Candidate Tags**: List all candidate tags available for the organization.
- **List Close Reasons**: List reasons available for closing openings.
- **List Communication Templates**: List communication templates available for messaging candidates.
- **List Custom Fields**: List custom fields defined in the organization.
- **List Departments**: Retrieve a list of all departments in the organization with hierarchy information.
- **List Feedback Form Definitions**: List feedback form definitions available in the organization.
- **List Hiring Team Roles**: List roles that can be assigned to job hiring team members.
- **List Interviewer Pools**: List interviewer pools in the organization.
- **List Interview Events**: List interview events (occurrences) for a candidate or schedule.
- **List Interview Plans**: List interview plans available in the organization.
- **List Interviews**: List interview definitions used in interview plans.
- **List Interview Schedules**: Retrieve a list of interview schedules including timing, interviewers, and meeting details.
- **List Interview Stage Groups**: List interview stage groups for an interview plan.
- **List Interview Stages**: Retrieve all interview stages for a specific interview plan in order.
- **List Job Boards**: List public job boards configured for the organization.
- **List Job Postings**: List job postings across all jobs with optional filters.
- **List Jobs**: Retrieve a paginated list of all jobs with status, hiring team, and interview plan details.
- **List Job Templates**: List job templates available to create jobs from.
- **List Locations**: Retrieve a list of all office locations in the organization.
- **List Offers**: Retrieve a paginated list of job offers with status and version details.
- **List Openings**: Lists openings with support for cursor-based pagination and incremental sync tokens.
- **List Projects**: Lists projects with support for cursor-based pagination and incremental sync tokens.
- **List Sources**: Lists all candidate sources, optionally including archived ones.
- **List Source Tracking Links**: Lists all source custom tracking links, optionally including disabled ones.
- **List Survey Form Definitions**: Lists all survey form definitions with cursor-based pagination and incremental sync.
- **List Survey Requests**: Lists survey requests (currently only CandidateExperience type is supported).
- **List Survey Submissions**: Lists survey submissions for a given survey type (CandidateExperience or Questionnaire).
- **List User Interviewer Pauses**: Lists all active or scheduled interviewer pauses for a user.
- **List Users**: Retrieve a list of all users (team members) in the organization with roles and status.
- **Move Department**: Move a department under a different parent in the hierarchy.
- **Move Location**: Moves a location to a new parent location hierarchy.
- **Remove Application Hiring Team Member**: Remove a user from the hiring team of a specific application.
- **Remove Candidate from Project**: Remove a candidate from a project.
- **Remove Candidate Tag**: Remove a tag from a candidate.
- **Remove Hiring Team Member**: Remove a user from the hiring team of a job.
- **Remove Job from Opening**: Removes a job from an opening.
- **Remove Location from Opening**: Removes a location from an opening.
- **Remove User from Interviewer Pool**: Remove a user from an interviewer pool.
- **Restore Department**: Restore a previously archived department.
- **Restore Interviewer Pool**: Restore a previously archived interviewer pool.
- **Restore Location**: Restores an archived location or location hierarchy.
- **Search Candidates**: Search for candidates by email (exact match) or name (partial match).
- **Search Jobs**: Search jobs by title for pipeline triggers and dashboards.
- **Search Openings**: Searches for openings by their human-readable identifier.
- **Search Projects**: Searches for projects by title (returns up to 100 results, useful for autocomplete).
- **Search Users**: Searches for an Ashby user by email address.
- **Set Candidate Fraud Status**: Set the fraud status (e.g. flagged, cleared) for a candidate.
- **Set Custom Field Value**: Set a custom field value on a specific object record.
- **Set Custom Field Values**: Set multiple custom field values on a specific object record in one call.
- **Set Job Status**: Change a job's status (draft, open, closed, archived).
- **Set Opening Archived**: Sets the archived state of an opening.
- **Set Opening State**: Updates the state (Draft, Approved, Open, Closed) of an opening.
- **Start Assessment**: Start a partner assessment for a candidate (called by Ashby).
- **Start Offer**: Creates and returns an offer version instance to be filled and submitted via offer.create.
- **Start Offer Approval Process**: Starts the approval process for an offer in a WaitingOnApprovalStart state.
- **Start Offer Process**: Starts a new offer process for an application.
- **Submit Application Feedback**: Submit interviewer feedback against a form definition for an application.
- **Submit Application Form**: Submit an application form response to create an application and candidate.
- **Transfer Application**: Transfer an application from one job to another.
- **Update Application**: Update an existing application, including source, creditedToUser, and createdAt.
- **Update Application History**: Update an existing history entry for an application.
- **Update Approval Definition**: Update the steps of an approval definition.
- **Update Assessment**: Send an assessment status or score update into Ashby from a partner.
- **Update Candidate**: Update a candidate's profile fields including name, email, phone, and links.
- **Update Custom Field Selectable Values**: Update the selectable options on a select-type custom field.
- **Update Department**: Update a department's name or other attributes.
- **Update Interviewer Pool**: Update an interviewer pool's settings.
- **Update Interview Schedule**: Update a scheduled interview's events, times, or interviewers.
- **Update Job**: Update a job's title, team, location, or related settings.
- **Update Job Compensation**: Update the compensation range on a job.
- **Update Job Posting**: Update a job posting's publish/listed state, copy, and settings.
- **Update Location Address**: Updates the postal address of a location.
- **Update Location External Name**: Updates the candidate-facing external name of a location.
- **Update Location Name**: Updates the name of a location or location hierarchy.
- **Update Location Workplace Type**: Updates the workplace type of a location (OnSite, Hybrid, Remote).
- **Update Offer**: Updates an existing offer, creating a new version and retriggering approval steps.
- **Update Opening**: Updates an existing opening's metadata (identifier, description, team, target dates, employment type).
- **Update User Interviewer Settings**: Updates daily/weekly interview limits for a user. Pass null to unset a limit.
- **Update Webhook**: Updates an existing webhook setting's enabled state, URL, or secret token.
- **Upload Candidate File**: Upload and attach a file to a candidate's profile.
- **Upload Candidate Resume**: Upload and attach a resume to a candidate's profile.

## Triggers (10)

- **Candidate Applied in Ashby**: Triggers when a new application is created in Ashby
- **Candidate Hired in Ashby**: Triggers when an application's status transitions to Hired
- **Application Changed Stage in Ashby**: Triggers when an application's current interview stage changes
- **Interview Schedule Created in Ashby**: Triggers when a new interview schedule is created
- **Interview Schedule Updated in Ashby**: Triggers when any field on an interview schedule changes
- **Offer Created in Ashby**: Triggers when a new offer is created in Ashby
- **Offer Updated in Ashby**: Triggers when any field on an existing offer changes
- **Job Posting Published in Ashby**: Triggers when a job posting is published to a job board
- **Job Posting Unpublished in Ashby**: Triggers when a previously published job posting is taken down
- **Opening Created in Ashby**: Triggers when a new opening (headcount slot) is created

## Related prompts

- [Draft Ashby interview scorecards from Metaview AI notes](https://www.generalinput.com/prompts/draft-ashby-interview-scorecards-from-metaview-ai-notes.md)
- [Daily pay transparency check for new Ashby job postings](https://www.generalinput.com/prompts/daily-pay-transparency-check-for-new-ashby-job-postings.md)
- [Transcribe recruiting interviews into Ashby notes with speaker labels](https://www.generalinput.com/prompts/transcribe-recruiting-interviews-into-ashby-notes-with-speaker-labels.md)
- [Score new Google Form job applicants and file them in Ashby](https://www.generalinput.com/prompts/score-new-google-form-job-applicants-and-file-them-in-ashby.md)
- [Auto-enrich new Ashby candidates with People Data Labs](https://www.generalinput.com/prompts/auto-enrich-new-ashby-candidates-with-people-data-labs.md)
- [New hire ops onboarding from Ashby to Linear and Notion](https://www.generalinput.com/prompts/new-hire-ops-onboarding-from-ashby-to-linear-and-notion.md)
- [Daily stalled-candidate nudge from Ashby to recruiters in Slack](https://www.generalinput.com/prompts/daily-stalled-candidate-nudge-from-ashby-to-recruiters-in-slack.md)
- [Auto-send Docusign offer letters from Ashby](https://www.generalinput.com/prompts/auto-send-docusign-offer-letters-from-ashby.md)
- [Announce new Ashby job postings on LinkedIn and Slack](https://www.generalinput.com/prompts/announce-new-ashby-job-postings-on-linkedin-and-slack.md)
- [Log every Ashby stage change to a Google Sheets pipeline tracker](https://www.generalinput.com/prompts/log-every-ashby-stage-change-to-a-google-sheets-pipeline-tracker.md)
- [New hire onboarding kickoff from Ashby to Outlook](https://www.generalinput.com/prompts/new-hire-onboarding-kickoff-from-ashby-to-outlook.md)
- [Send interviewers a personalized prep brief in Slack before each interview](https://www.generalinput.com/prompts/send-interviewers-a-personalized-prep-brief-in-slack-before-each-interview.md)

Connect Ashby in General Input: https://www.generalinput.com/apps/ashby