Ashby

Add an Ashby user to the hiring team at the application level. Use this when you need to assign a team member to participate in the hiring process for a specific application with a specific role. Requires the candidateWrite permission.

Add a candidate to a project. Use this to associate candidates with sourcing projects or recruiting initiatives. Requires candidatesWrite permission.

Add a tag to a candidate. Use this to categorize and organize candidates with existing tags from the system.

Add an Ashby user to a hiring team at the application, job, or opening level. Use this when you need to assign a team member to participate in the hiring process with a specific role. Requires the organizationWrite permission.

Add a user to an interviewer pool. Use this to assign interviewers to interview pools for scheduling and coordination. Requires the hiringProcessMetadataWrite permission.

Tool to add a job to an opening (job requisition). Use when you need to associate a job with an existing opening. Requires the jobsWrite permission.

Tool to add a location to an opening (job requisition). Use when you need to associate a location with an existing opening. Requires the jobsWrite permission.

Anonymize a candidate by removing personally identifiable information. Use this when you need to permanently anonymize a candidate's data. This action cannot be reversed and requires all of the candidate's applications to be in the archived or hired state.

Archive a department by its ID. Use this to mark a department as archived, which removes it from active use while preserving its data.

Tool to archive an interviewer pool. Use when you need to archive a pool that is no longer active. Requires the hiringProcessMetadataWrite permission.

Archives a location or location hierarchy. Requires the organizationWrite permission. Use this to mark locations as archived in the system.

Change the source attribution of an application. Use this to update which source and user should be credited for bringing in the candidate.

Move an application to a different interview stage. Use this to advance or move candidates through the hiring pipeline by changing their current interview stage.

Create a new application for a candidate to a specific job. Use this to add a candidate to a job's hiring pipeline, optionally specifying the source, credited user, and initial interview stage.

Create a new candidate in the system. Use this to add candidates with their contact information and social profiles before applying them to jobs.

Create a note on a candidate profile. Use this to add comments, observations, or feedback about a candidate during the recruitment process.

Create a new candidate tag. Use this to add new tags for categorizing and organizing candidates.

Create a new custom field in Ashby. Use this to add custom fields that can be set on candidates, applications, jobs, or other objects. Requires the hiringProcessMetadataWrite permission.

Create a new department. Use this to add organizational departments or teams for structuring jobs and hierarchy.

Create a new interviewer pool. Use this to organize interviewers into groups by expertise or interview type. Requires the hiringProcessMetadataWrite permission.

Create a new job opening. Use this to add a new role to the organization with title, team, location, and brand. Job cannot be opened without a default interview plan.

Create a new location or location hierarchy. Use this to add office locations, remote work settings, or nested location structures for organizational management.

Create a new opening (job requisition). Use this to create a job opening with details like title, team, locations, and employment type. Requires openingsWrite permission.

Generate a survey request and receive a survey URL to send to a candidate. Use this when you need to collect feedback or information from candidates via a survey. Requires candidatesWrite permission. Note that calling this endpoint does not automatically email the survey to the candidate.

Create a new survey submission for a candidate's application. Use this to submit candidate survey responses programmatically, such as candidate experience ratings or feedback forms. Requires the candidatesWrite permission.

Retrieve information about the current API key, including associated organization, user details, and permissions. Use this to verify API key validity and check what access level the key has.

Retrieve detailed information about a specific application by its ID. Use this to get complete details about an application including candidate info, interview stages, hiring team, and more.

Retrieve detailed information about a specific candidate by their ID. Use this to get complete candidate details including contact information, applications, social profiles, and more.

Retrieve detailed information about a specific custom field by its ID. Use this to get custom field details including title, object type, field type, and selectable values. Requires the hiringProcessMetadataRead permission.

Retrieve detailed information about a specific department by its ID. Use this to get department details including name, hierarchy, and archive status.

Retrieve detailed information about a specific feedback form by its ID. Use this to get complete details about a feedback form including title, configuration, and form definition. Requires the hiringProcessMetadataRead permission.

Retrieve the URL of a file associated with a candidate. Use this to get a pre-signed S3 URL for accessing candidate files like resumes. Requires the candidatesRead permission.

Retrieve detailed information about a specific interviewer pool by its ID. Use this to get interviewer pool details including name, interviewers, and configuration.

Get interviewer settings for a specific user by their ID. Use this to retrieve daily and weekly interview limits configured for the user. Requires the organizationRead permission.

Retrieve detailed information about a specific interview type by its ID. Use this to get interview details including title, instructions, and feedback form configuration.

Tool to fetch interview stage details by ID. Use when you need specific information about an interview stage including its title, type, order, and parent interview plan. Requires the interviewsRead permission.

Retrieve detailed information about a specific job by its ID. Use this to get complete details about a job including title, status, hiring team, interview plans, and more.

Retrieve detailed information about a specific job posting by its ID. Use this to get complete job posting details including full description, application form fields, compensation, and publish settings.

Retrieve detailed information about a specific location by its ID. Use this to get complete location details including address, remote status, and workplace type.

Retrieve detailed information about a specific opening (job requisition) by its ID. An opening represents a headcount position that needs to be filled. Each opening belongs to a job and tracks hiring progress including state (Open/Closed), hiring team members, employment type, and target dates. Use this action to: - Get complete details about a specific opening including its current state - View the hiring team assigned to the opening - Check employment type, target hire date, and target start date - Access custom fields associated with the opening Returns opening details on success, or error information if the opening ID is invalid.

Fetches the default referral form or creates a default referral form if none exists. Requires the hiringProcessMetadataRead permission.

Retrieve detailed information about a specific survey form definition by its ID. Use this to get complete details about a survey form including title, configuration, and form definition. Requires the hiringProcessMetadataRead permission.

Retrieve detailed information about a specific user by their ID. Use this to get user details including name, email, role, and permissions.

Retrieve AI-generated criteria evaluations for an application. Use this to get the AI assessment of how well a candidate meets specific job requirements, including evaluation outcomes and reasoning.

Retrieve all feedback submissions for an application. Use this to view interviewer feedback, evaluations, and notes collected throughout the hiring process.

Retrieve all available hiring team roles for applications in the organization. Use this to get the list of roles that can be assigned to hiring team members on applications.

Retrieve the complete history of stage transitions for an application. Use this to get detailed information about when and how a candidate moved through different interview stages.

Retrieve a list of applications. Use this to fetch applications with optional pagination and filtering by sync token for incremental updates.

Retrieve a list of approvals (offer approvals, job approvals, etc.). Use this to track approval workflows and pending approvals.

Retrieve a list of all archive reasons. Use this to see available reasons for archiving candidates or applications, such as rejection categories.

Retrieve a list of all brands for the organization. Use this to get available brands for job postings and employer branding. Requires organizationRead permission.

Retrieve all client info records for a specific candidate. Use this to view client-specific information associated with the candidate. Requires candidatesRead permission.

Retrieve all notes for a specific candidate in Ashby. Use this action to view comments, observations, and internal notes added by recruiters and hiring team members during the hiring process. Common use cases: - Review feedback and observations from interviewers - Check historical communication and decisions about a candidate - Audit the hiring process for a specific candidate Prerequisites: - You need a valid candidateId. Get this from list_candidates or search_candidates. - Requires 'candidatesRead' permission in Ashby. Returns an empty list if the candidate has no notes.

Retrieve all projects associated with a candidate. Use this to see which sourcing projects or recruiting initiatives a candidate is part of.

Retrieve a list of candidates. Use this to fetch all candidates with optional pagination and filtering by sync token for incremental updates.

Retrieve a list of all candidate tags in your Ashby account. Tags are labels used to categorize and organize candidates for filtering and search purposes. Use this action to: - Get all available tags for tagging candidates - Implement incremental sync using the syncToken parameter - Paginate through large sets of tags using cursor Returns tag id, title, and archived status for each tag.

Retrieve a list of all close reasons for jobs and openings. Use this to see available reasons for closing job requisitions.

Retrieve a list of all communication templates. Use this to see available email and message templates for candidate outreach.

Retrieve a list of all custom field definitions configured in Ashby. Use this action to discover what custom fields are available for candidates, applications, jobs, offers, and openings. This is useful when you need to: - Know what custom fields exist before setting values on resources - Understand the data types and available options for each field - Identify the IDs of custom fields needed for other API operations Returns fields with their types (String, Number, Boolean, Date, ValueSelect, MultiValueSelect, Currency, CompensationRange) and selectable values for dropdown fields.

Retrieve a list of all departments in the organization. Use this action to: - Get all departments for organizing jobs and candidates by team structure - Find department IDs needed for creating or filtering jobs - Understand the organizational hierarchy via parentId relationships - Perform incremental syncs to detect newly created or updated departments Supports pagination for large organizations. When moreDataAvailable is true, use the nextCursor value in subsequent requests to fetch more results.

Retrieve all feedback form definitions from your Ashby organization. Use this action to: - Discover available interview feedback templates - Get form IDs for use with other feedback-related actions - Understand the structure of feedback forms including fields and sections - Identify the default feedback form vs custom scorecards Returns a list of feedback forms with their complete structure, including field types (ValueSelect, MultiValueSelect, Boolean, RichText) and selectable values.

Retrieve a list of possible hiring team roles in the organization. Use this to get available roles that can be assigned to members of a hiring team (e.g., Hiring Manager, Recruiter, Recruiting Coordinator, Sourcer). Requires the organizationRead permission.

Retrieve a list of all interviewer pools. Interviewer pools are groups of interviewers organized by expertise, role, or interview type (e.g., "Backend Engineer", "Bar Raiser"). Use this to see available interviewer pools for scheduling interviews or managing interview assignments. Supports pagination via cursor and incremental sync via syncToken.

Lists interview events associated with an interview schedule. Use this to retrieve all scheduled interview events for a specific interview schedule, including timing, interviewers, and meeting details. Supports pagination and incremental synchronization.

Retrieve a list of interview plans. Use this to get the structured interview processes and stages configured for different roles.

List all interview types defined in Ashby. Returns interview templates/definitions (e.g., 'Technical Phone Screen', 'Debrief', 'Intro Call with CEO') rather than scheduled interview instances. Use this to discover available interview types for building interview plans or to sync interview type data. Supports pagination via cursor and incremental sync via syncToken.

Retrieve a list of interview schedules. Use this to fetch all scheduled interviews with candidates, including timing, interviewers, and interview details.

Retrieve a list of interview stage groups. Use this to see how interview stages are organized into logical groups within interview plans.

Retrieve all interview stages for an interview plan in order. Use this to get the structured sequence of stages a candidate progresses through during the interview process for a specific role. Requires interviewsRead permission.

Retrieve a list of job boards. Use this to see where job postings can be published (e.g., LinkedIn, Indeed, company career page).

Retrieve a list of job postings. Use this to fetch all public job postings with optional pagination and filtering.

Retrieve a list of all jobs from Ashby ATS (Applicant Tracking System). Use this action to: - Fetch all open, closed, or draft jobs in your organization - Get job details including title, status, employment type, department, and hiring team - Paginate through large result sets using cursor-based pagination - Perform incremental syncs using syncToken to only fetch changed jobs Each job includes comprehensive information such as hiring team members, interview plan IDs, job posting IDs, custom fields, and timestamps.

Retrieve a list of all job templates from Ashby ATS. Use this action to: - Discover available job templates for creating standardized job postings - View both active and inactive templates in your organization - Get template details including title, department, location, and employment type - Paginate through results using cursor-based pagination - Perform incremental syncs using syncToken to only fetch changed templates Job templates provide reusable configurations that help maintain consistency when creating new jobs in your organization.

Retrieve a list of all locations. Use this to get available office locations and remote work settings for jobs.

Retrieve a list of job offers. Use this to fetch all offers made to candidates with optional pagination and filtering.

Retrieve a list of openings (job requisitions). Use this to fetch all openings with optional pagination and filtering.

Retrieve a list of all projects. Use this to see candidate sourcing projects and recruiting initiatives.

Retrieve a list of all candidate sources. Use this to get available sources for categorizing how candidates were sourced (e.g., LinkedIn, referrals, job boards).

Retrieve all source tracking links configured in Ashby. Source tracking links are UTM-tagged URLs used to track where candidates are coming from (e.g., LinkedIn, job boards, referral campaigns). Use this action to: - View all active and inactive tracking links - Get tracking codes for analytics and reporting - Find the sourceId associated with each tracking link This is a read-only operation that requires no parameters.

Retrieve a list of all survey form definitions from Ashby. Use this action to discover available candidate survey templates including: - Candidate Experience Surveys (NPS ratings for candidate feedback) - Hiring Manager Experience Surveys (feedback on recruiting process) - Quality of Hire Assessments (post-hire performance ratings) - EEOC Surveys (equal employment opportunity information collection) Each survey form contains sections with fields defining the questions and response types. This is a read-only operation that does not require any parameters.

Retrieve a list of survey submissions for a given survey type. Use this to fetch candidate survey responses with optional pagination and filtering by sync token. Requires candidatesRead permission.

Retrieve a list of all users in the organization. Use this to get information about team members, their roles, and permissions.

Tool to move a department to another parent in the organizational hierarchy. Use when reorganizing department structure or changing parent-child relationships. Requires the organizationWrite permission.

Tool to remove a user from an interviewer pool. Use when you need to remove an interviewer from a specific pool. Requires the hiringProcessMetadataWrite permission.

Remove a job from an opening. Use this to disassociate a job from a specific opening requisition. Requires jobsWrite permission.

Tool to remove a location from an opening (job requisition). Use when you need to disassociate a location from an existing opening. Requires the jobsWrite permission.

Tool to restore an archived department. Use when you need to unarchive a department that was previously archived. Requires the organizationWrite permission.

Tool to restore an archived interviewer pool. Use when you need to unarchive an interviewer pool that was previously archived. Requires the hiringProcessMetadataWrite permission.

Tool to restore an archived location or location hierarchy. Use when you need to unarchive a location that was previously archived. Requires the organizationWrite permission.

Search for candidates by email or name. Use this for quick lookups to find specific candidates without pagination. Supports exact email match or partial name match.

Search for jobs by title in Ashby ATS (Applicant Tracking System). Use this action to: - Quickly find jobs by title without pagination - Perform partial match searches (e.g., "engineer" matches "Backend Engineer") - Look up specific job openings by name Returns matching jobs with full details including hiring team, department, location, interview plans, and job postings. Note: For listing all jobs or paginated results, use the List Jobs action instead.

Search for openings by identifier. Use this for quick lookups to find specific openings without pagination. Returns empty results if no match found.

Search for projects by title in Ashby. Use this action to quickly find specific sourcing projects or recruiting initiatives by searching their titles. This endpoint is ideal for: - Building project autocomplete features - Finding projects when you know part of the project name - Quick lookups without pagination Note: Results are limited to 100 matches. For larger result sets, use the List Projects action instead.

Search for an Ashby user by email address. Use this to find specific team members in the organization when you know their email. Returns matching user details including their ID, name, role, and status. Requires organizationRead permission.

Set the value of a custom field for a given object (candidate, application, job, etc.). Use when you need to update a single custom field value. Important: When updating multiple custom fields on the same object, use customField.setValues instead to avoid race conditions.

Set the status of a job in Ashby ATS (Applicant Tracking System). Use this action to change the workflow state of a job: - Set to 'Open' to make a job actively accept applications - Set to 'Closed' to stop accepting applications for a job - Set to 'Draft' to put a job back into preparation mode Common use cases: - Close a job after filling the position - Open a draft job to start accepting applications - Transition a job through the hiring workflow Important limitations: - Cannot transition from Open to Draft (must close first) - Cannot transition from Closed to Open (create a new job instead) Returns the updated job details on success, or error information if the status transition is not allowed.

Sets the archived state of an opening. Requires the jobsWrite permission. Use this to archive or unarchive job openings.

Tool to set the state of an opening (job requisition). Use when you need to change an opening's state to Draft, Approved, Open, or Closed. When closing an opening, a close reason ID must be provided.

Submit structured feedback for an application using a feedback form. Use this for formal interview feedback and scorecards, not for informal notes or comments.

Update an application's properties in Ashby. Use this action to modify application metadata such as: - Source attribution (how the candidate found or was found for the job) - Credited user (who should get credit for sourcing the candidate) - Creation date (useful for backdating imported applications) - Notification settings for the update Note: To update custom fields on applications, use the customFields.setValue endpoint instead. To change the application's interview stage, use change_application_stage. To archive/unarchive, use the archive actions. Returns the full updated application object with all current field values.

Update the complete history of an application's stage transitions. Use this to modify stage entry times, delete history events, or update existing history records. CRITICAL: This endpoint requires sending the COMPLETE application history array - use list_application_history first to retrieve all existing entries, then modify and send back the full array.

Update an existing candidate's profile information in Ashby ATS. Use this action to modify candidate details like name, email, phone number, job title, company, school, and social profiles (LinkedIn, GitHub, website). Requires a valid candidateId which can be obtained from list_candidates or search_candidates actions. Note: To update custom fields, use the customFields.setValue endpoint separately.

Update an existing department's information such as its name. Use this action to: - Rename a department to reflect organizational changes - Update department names with Unicode/international characters - Modify department details as your organization evolves Prerequisites: - You need a valid departmentId (obtain from list_departments action) - The department must not be archived - At least one field (e.g., name) must be provided for the update Note: The externalName is automatically updated to match the name.

Tool to update an interviewer pool. Use when you need to modify the title or training requirements of an existing interviewer pool. Requires the hiringProcessMetadataWrite permission.

Update an existing job's properties in Ashby ATS. Use this action to modify job details such as: - Job title (e.g., change "Engineer" to "Senior Engineer") - Department/team assignment - Office location - Default interview plan - Confidentiality settings - Custom requisition ID Prerequisites: - You need a valid jobId from list_jobs or search_jobs - For teamId, get valid IDs from list_departments - For locationId, get valid IDs from list_locations - For defaultInterviewPlanId, get valid IDs from list_interview_plans Note: To update custom fields, use the customFields.setValue endpoint instead. To change job status (open/close/archive), use the set_job_status action.

Update job posting details such as title or listing status. Use this to modify public job postings and control visibility.

Update the address of a location or location hierarchy. Use this when you need to modify location address details such as city, region, country, or postal code. Requires the organizationWrite permission.

Update a location's name. Use this to rename an existing location. Requires the organizationWrite permission.

Tool to update a location's remote status. Use when you need to mark a location as remote or non-remote. Requires organizationWrite permission.

Tool to update a location's workplace type (OnSite, Remote, or Hybrid). Use when you need to modify the workplace setting for an office location. Requires organizationWrite permission.

Update properties of an existing opening (job requisition). Use this to modify opening details such as description, team, hire dates, and employment type. Requires jobsWrite permission.

Update interviewer settings for a user, including daily and weekly interview limits. Use this when you need to set or modify interview scheduling constraints for a user. Either limit can be provided individually or both together; unprovided limits remain unchanged.