Reference

Change Application Stage

Move candidates through different stages of your hiring pipeline, from initial application review through offers and hiring decisions. This keeps your recruitment process organized and ensures candidates progress smoothly based on your interview plan.

List Applications

Retrieve all job applications submitted to your hiring process, with support for filtering and pagination to manage large volumes of applicants. This helps you keep track of every candidate in your recruitment pipeline.

Update Application

Modify key properties of a job application in Ashby, including source attribution, credited recruiter, and creation date. This helps maintain accurate candidate tracking and ensures proper credit assignment in your hiring pipeline.

Change Application Source

Updates which recruitment source and team member should be credited for a candidate application, allowing you to correct or reassign source attribution after initial submission.

Create Application

Create a new job application in Ashby by linking a candidate to a job opening, automatically adding them to the hiring pipeline and tracking their progress through interview stages.

Get Application Info

Retrieve comprehensive details about a job application including candidate information, interview stages, and hiring team members. Use this to access the complete status and history of any application in your hiring pipeline.

List Application Criteria Evaluations

Retrieves AI-generated assessments of how well candidates meet specific job requirements, showing evaluation scores and reasoning for each criterion. This helps you quickly understand candidate fit without manual review.

List Application Feedback

Retrieve all feedback and evaluations submitted by interviewers for a specific job application, helping you make informed hiring decisions based on team input.

List Application History

Track when and how a candidate progressed through your hiring stages to understand your recruitment timeline and identify bottlenecks in your interview process.

Submit Application Feedback

Submit structured feedback and scorecards for job applicants during your hiring process. This operation captures formal interview assessments and evaluation scores to help you track candidate quality and make informed hiring decisions.

Transfer Application

Move a candidate's application from one job position to another in your hiring pipeline while maintaining their interview history and application context. This helps you consider candidates for alternative roles that better match their qualifications or career interests.

Update Application History

Modify an application's stage transition history by updating entry times, removing historical events, or correcting past records. This is useful when you need to accurately reflect how a candidate moved through your hiring pipeline.

Create Candidate

Add a new candidate to your recruitment system with their contact details and social profiles, ready to apply to open positions.

List Candidates

Retrieve a list of all candidates in your hiring pipeline with optional filtering and pagination to stay updated on your recruitment progress.

Search Candidates

Quickly locate specific candidates in your hiring pipeline by searching for their email address or name, enabling you to retrieve candidate information without browsing through full lists.

Add Candidate Tag

Organize and categorize candidates by applying tags to their profiles, making it easier to filter, search, and manage your candidate pipeline. Use existing tags to group candidates by status, skills, or any custom criteria relevant to your hiring process.

Add Candidate to Project

Associates a candidate with a specific recruiting project or sourcing campaign in Ashby, helping you organize and track candidates within targeted hiring initiatives.

Anonymize Candidate

Permanently remove all personally identifiable information from a candidate's record to comply with privacy regulations or data retention policies. This action is irreversible and requires all of the candidate's applications to be archived or completed.

Create Candidate Note

Add notes, comments, or feedback directly to a candidate's profile to track your thoughts and observations throughout the hiring process.

Create Candidate Tag

Create custom labels to organize and categorize candidates in your hiring pipeline for easier filtering and searching. This helps you quickly segment candidates by relevant criteria like skills, experience level, or department.

Get Candidate Info

Fetch complete candidate details including contact information, social profiles, applications, and custom fields by candidate ID. Use this to access a candidate's full profile for evaluation, communication, or follow-up purposes.

List Candidate Client Info

Retrieves all client-specific information linked to a candidate, enabling you to access additional details and notes stored in your Ashby account for each hire.

List Candidate Notes

Retrieves all notes and feedback recorded for a specific candidate in Ashby, including interviewer comments, observations, and internal notes from your hiring team throughout the recruitment process.

List Candidate Projects

View all projects a candidate is currently involved with, helping you understand their engagement across different recruiting initiatives and sourcing efforts.

List Candidate Tags

Retrieve all candidate tags available in your Ashby account to see how candidates are organized and labeled. This helps you understand your tagging system and maintain consistent candidate categorization across your hiring process.

Update Candidate

Modify an existing candidate's core information in your Ashby ATS, such as contact details, employment history, education, and social profiles. This keeps candidate records current as you learn more about them throughout the hiring process.

Get API Key Info

Retrieve details about your API key including which organization it's connected to and what data access it provides. This helps you verify the key is working correctly before performing important actions in your recruitment system.

List Archive Reasons

Retrieve all available reasons for archiving candidates or applications in your recruitment system. This helps you understand and maintain consistent categorization when closing out candidate records.

List Brands

Retrieve all brands available in your organization to use for job postings and career page branding. This helps you manage how your company appears to job candidates across different posting channels.

List Close Reasons

Retrieve all close reasons used to categorize why jobs or openings were closed in your hiring process, such as candidate rejections or organizational decisions.

List Source Tracking Links

Retrieve all UTM-tagged source tracking links configured in your Ashby recruitment account to see where candidates are coming from across different channels. Use this to audit your candidate source tracking setup and gather analytics codes for reporting.

List Sources

Retrieve all available candidate sources in your hiring system to understand and categorize where your candidates are coming from. This helps you track recruitment channel effectiveness and optimize your sourcing strategy.

Create Custom Field

Create custom fields in Ashby to track additional information like candidate qualifications, job requirements, or application details beyond the standard fields. This lets you organize and store structured data that matches your specific hiring workflow.

Get Custom Field Info

Retrieve detailed information about a custom field including its name, type, and available values. This helps you understand how candidate data is structured and what options are available for custom fields in your hiring process.

List Custom Fields

Retrieve all custom field definitions configured in your Ashby workspace to understand what candidate, application, job, and offer data you can track. This helps you identify which custom fields are available before programmatically setting values or building integrations.

Set Custom Field Value

Update a single custom field value for any object in Ashby like candidates, applications, or jobs. Use this when you need to modify one specific piece of custom information without affecting other fields.

Set Custom Field Values

Update multiple custom fields on candidates, applications, jobs, or openings all at once, ensuring data consistency without conflicting updates.

Update Selectable Values Custom Field

Modify the available options in dropdown or multi-select custom fields for your hiring pipeline, allowing you to add new choices, update existing labels, or remove outdated options without losing data.

Archive Department

Hide a department from your active organization structure while keeping all its historical data and records intact, allowing you to clean up your department list without losing information.

Create Department

Create a new department in your hiring organization to establish organizational structure, manage teams, and organize job postings by business unit.

Get Department Info

Retrieve detailed information about a specific department including its name, hierarchy, and archive status to understand your organizational structure and verify department details.

List Departments

Retrieve all departments in your organization to view your team structure and organize hiring efforts by department. Use this to get department IDs and understand reporting hierarchies for managing jobs and candidates.

Move Department

Move a department to a different parent in your organizational hierarchy, allowing you to restructure your company's reporting lines and department groupings as your business evolves.

Restore Department

Reactivate a previously archived department, making it available for job postings and organizational assignments while preserving all historical data and relationships.

Update Department

Modify an existing department's information, such as renaming it to reflect organizational changes or updates. This helps you keep your organizational structure current as your business evolves.

Get File Info

Retrieve secure access URLs for candidate files like resumes and documents stored in your hiring system. This lets you quickly access and review candidate materials without leaving your workflow.

Add Hiring Team Member

Assigns a team member to participate in the hiring process for a specific job, opening, or application with a designated role. This enables you to delegate hiring responsibilities and coordinate collaboration across your team.

List Application Hiring Team Roles

Fetch all available hiring team roles that can be assigned to team members for specific job applications. This helps you understand what responsibilities and titles are available when building out your recruitment team structure.

List Hiring Team Roles

Retrieve all available hiring team roles that can be assigned to your team members, such as Hiring Manager, Recruiter, or Sourcer. This helps you understand what role options are available before assigning people to recruiting tasks.

Remove Hiring Team Member

Unassign a team member from a hiring team so they no longer participate in reviewing applications or making hiring decisions for a specific job or opening.

Add User to Interviewer Pool

Assign team members to interview pools so they can conduct candidate interviews and be available for scheduling. This streamlines your hiring process by organizing who's responsible for interviewing at each stage.

Archive Interviewer Pool

Archive an interviewer pool to mark it as inactive and prevent it from being used for new interview assignments, while keeping all historical interview data intact.

Create Interviewer Pool

Organize your interview team by grouping interviewers based on their expertise or the types of interviews they conduct, making it easier to assign the right interviewer to each candidate.

Get Interview Info

Retrieve comprehensive details about a specific interview including its title, instructions, and feedback form configuration to understand how candidates will be evaluated.

Get Interview Stage Info

Retrieve detailed information about a specific interview stage, including its title, type, and position in your hiring workflow.

Get Interviewer Pool Info

Retrieves detailed information about an interviewer pool including its members, trainees, and training structure, enabling you to understand who is available to conduct interviews and their current status.

Get Interviewer User Settings

Retrieve interview scheduling limits and preferences for a specific team member to understand their availability capacity. This helps you manage interview workload and plan candidate scheduling appropriately.

Get Job Interview Plan Info

Retrieve the structured interview stages and process details configured for a specific job opening, helping you understand how candidates will be evaluated through your hiring workflow.

List Interview Events

Retrieves all scheduled interview events for a specific interview schedule, including timing, assigned interviewers, locations, and feedback status. Use this to track your interview pipeline and coordinate with interviewers.

List Interview Plans

Retrieve all interview plans configured in your hiring system to see the structured interview processes and stages set up for different roles. This helps you understand your recruitment workflows and ensure consistency across hiring.

List Interview Schedules

Retrieve all scheduled candidate interviews with details like timing, interviewers, and format to keep your hiring process organized and transparent. Use this to stay on top of your recruitment pipeline and ensure no candidate meetings slip through the cracks.

List Interview Stage Groups

Retrieve all interview stage groups to understand how your hiring process is organized and structured within your interview plans.

List Interview Stages

Retrieve the complete list of interview stages in order for a specific interview plan, showing the structured sequence candidates progress through during hiring.

List Interview Types

Retrieve all interview types configured in your Ashby hiring system, such as phone screens, technical assessments, and executive debriefs. Use this to understand your interview workflow structure and automate interview scheduling or candidate tracking.

List Interviewer Pools

Retrieve all available interviewer pools in your hiring system to see which groups of interviewers are ready for interview scheduling and assignments. This helps you quickly identify the right interview team for each candidate based on role or expertise.

Remove User from Interviewer Pool

Remove a team member from an interviewer pool so they no longer participate in interviews for that specific hiring process or role.

Restore Interviewer Pool

Unarchives an interviewer pool in Ashby, making it available again for assigning interviews to candidates. Use this to reactivate a pool that was previously archived without losing its configuration.

Update Interviewer Pool

Modify an existing interviewer pool's name and training requirements to keep your hiring team organized and ensure proper interview standards are maintained.

Update User Interviewer Settings

Modify a user's interview scheduling limits to control how many interviews they can conduct per day or week. This helps manage interviewer workload and prevents scheduling bottlenecks during your hiring process.

List Jobs

Retrieve all jobs from your Ashby ATS system to view open positions, drafts, and closed roles with details like titles, departments, and hiring teams. This helps you maintain visibility across your entire recruitment pipeline and sync hiring information with other business tools.

Create Job

Create a new job opening in your Ashby ATS system with details like title, department, location, and brand to begin building out your hiring pipeline.

Get Job Info

Retrieve comprehensive details about a specific job opening, including title, status, hiring team, and interview plans, to keep track of your recruiting activities.

Get Job Posting Info

Retrieve comprehensive details about a specific job posting including the full description, application form fields, compensation information, and publication settings. Use this to review, audit, or integrate job posting data into your hiring workflow.

List Job Boards

View all available job boards where you can publish your open positions, including popular platforms like LinkedIn and Indeed as well as your company career page. This helps you understand which channels are available for recruiting.

List Job Postings

Retrieve all public job postings from your Ashby account to view open positions and their details. Use this to monitor your active job listings and share them with your team or candidates.

List Job Templates

Retrieve all job templates from your Ashby ATS to discover standardized job posting configurations and maintain consistency across your hiring process. This helps you quickly set up new job postings using pre-configured templates for different roles and departments.

Search Jobs

Find specific job openings in your Ashby ATS by searching for job titles, enabling quick lookup of positions without manually browsing through all listings.

Set Job Status

Change the status of a job posting in Ashby to control whether it's actively accepting applications, closed, or in draft mode. This helps you manage your hiring workflow and prevent applications after a position is filled.

Update Job

Modify key details of an existing job posting in Ashby, such as title, department, location, and interview process, to keep your hiring information current and accurate.

Update Job Compensation

Modify compensation packages for job postings in Ashby by setting salary ranges, equity, bonuses, and commission structures across different experience levels. This helps you create competitive job offers that reflect your market positioning and budget constraints.

Update Job Posting

Modify existing job postings to update titles, descriptions, and visibility settings across your job boards. Keep your hiring materials current and control which positions are publicly visible to candidates.

Archive Location

Archive inactive office locations in your Ashby system to mark them as unavailable for new job postings and assignments. This helps you maintain a clean, current list of active hiring locations.

Create Location

Add new office locations, remote work settings, or organizational hierarchies to your Ashby system for better team and candidate management. This helps you organize your hiring and team structure by geographic location or work arrangement.

Get Location Info

Retrieve complete details about a job location including its address, remote work policy, and workplace type. Use this to understand where positions are based and share accurate location information with candidates.

List Locations

Retrieve all office locations and remote work settings configured in your hiring system. Use this to see where your team is located and what work arrangements are available for new positions.

Move Location

Move a location to a different parent location in your organizational hierarchy, allowing you to reorganize how your locations are structured and grouped.

Restore Location

Reactivates an archived location in Ashby, making it available again for job postings and assignments. Use this when you need to bring a previously inactive office location back into your hiring workflow.

Update Location Address

Modify location address details like city, region, country, or postal code for office locations or organizational hierarchies. This keeps your recruiting data accurate when your business relocates or opens new offices.

Update Location External Name

Update how a job location appears to candidates on job boards and external platforms. This lets you customize location names without affecting your internal records.

Update Location Name

Rename an existing office location or work site to reflect organizational changes, relocations, or updates to your hiring structure.

Update Location Remote Status

Modify whether a location in your Ashby account is designated as remote or office-based, helping you accurately reflect your company's work setup in your hiring records.

Update Location Workplace Type

Modify how work is conducted at a specific office location by changing its workplace type between on-site, remote, or hybrid arrangements. Use this when your company's work policy for a location changes.

Approve Offer

Move job offers forward through your approval workflow by approving entire offers or specific approval steps within the process. Use this to streamline hiring decisions and ensure offers progress efficiently through your review stages.

Create Offer

Generate and submit a formal job offer for a candidate in your ATS system with all required details. This automates the offer creation process after you've initiated the offer workflow and retrieved the necessary form structure.

Get Offer Info

Retrieve detailed information about a specific job offer including its status, candidate details, job information, and custom fields. This helps you quickly access all offer data in one call without manually searching through your hiring pipeline.

List Approvals

Retrieve all pending and completed approvals across your hiring process, including offer and job approvals, to monitor workflow status and identify bottlenecks.

List Offers

Retrieve all job offers made to candidates in your Ashby account, with support for filtering by creation date and incremental syncing to track changes efficiently.

Start Offer

Initialize a new offer version for a candidate to prepare and submit hiring offer details. This creates an empty offer instance that you'll populate with compensation, benefits, and other job terms before sending it to the candidate.

Start Offer Process

Initiates the formal offer workflow for a candidate in Ashby ATS, moving them into the active offer creation stage. This triggers the offer process and generates a unique identifier to track the offer through completion.

Create Opening

Creates a new job opening in Ashby to formally request hiring for a specific position, allowing you to define requirements, locations, and hiring targets. This helps you organize and track your recruitment efforts across different roles and teams.

Add Opening Job

Associates a job definition with a position opening in your ATS so you can track and manage multiple roles within a single requisition. This helps you organize and link related positions together for streamlined hiring workflows.

Add Opening Location

Assign a physical location or remote work setting to a job opening so candidates know where they'll be working. This helps you organize job postings by office, multiple locations, or remote flexibility.

Get Opening Info

Retrieve detailed information about a specific job opening including its current status, hiring team, employment type, and key dates. Use this to track individual position details and hiring progress.

List Openings

Retrieve all active job openings and requisitions in your hiring pipeline, with options to filter and paginate through results to manage your recruitment workflow.

Remove Opening Job

Disassociate a job from a specific opening in your Ashby ATS, allowing you to reorganize job-opening relationships and correct misalignments. This helps you maintain accurate job requisitions and applicant tracking structures.

Remove Opening Location

Removes a location from a job opening, allowing you to disassociate a specific work location from an existing job requisition without deleting the entire position.

Search Opening

Quickly find specific job openings in your Ashby system by their unique identifier without needing to browse through all listings. Perfect for validating opening details or retrieving information for a particular position.

Set Opening Archived

Archive or unarchive job openings to manage your active hiring pipeline and keep your applicant tracking system organized.

Set Opening State

Transition a job opening between different workflow states (Draft, Approved, Open, or Closed) to manage your hiring pipeline and control which positions are actively recruiting.

Update Opening

Modify job opening details such as description, team assignments, hire dates, and employment type to keep your recruiting information current and accurate.

List Projects

Retrieve all your recruiting and sourcing projects in one view. Use this to track active hiring initiatives and see which projects candidates are being sourced for.

Search Projects

Quickly find recruitment projects in Ashby by searching for titles or keywords without browsing through full lists. Perfect for locating specific sourcing initiatives, recruiting campaigns, or candidate portfolios by name.

Create Referral

Submit employee referrals directly into your Ashby ATS, automatically creating candidate records and linking applications to open positions.

Get Referral Form

Retrieves or automatically generates a default referral form for your hiring process, ensuring you have a standardized way to collect employee referrals.

Create Survey Request

Create a survey request and generate a shareable survey URL to gather feedback or information directly from candidates during your hiring process.

Create Survey Submission

Submit survey responses and feedback directly into a candidate's application record, automating the capture of candidate experience ratings and interview feedback.

Get Survey Form Definition

Retrieve the complete structure and configuration details of a survey form used in your hiring process, including all fields, answer options, and requirements. Use this to understand what information is being collected from candidates or hiring managers.

List Survey Form Definitions

Retrieve all available survey form templates from Ashby to understand what candidate feedback and hiring assessments you can send. This helps you discover pre-built surveys for gathering feedback on candidate experience, hiring manager satisfaction, and post-hire performance.

List Survey Submissions

Retrieve candidate feedback and survey responses collected during your hiring process, including detailed answers and submission metadata that can be filtered and paginated for analysis.

Get Feedback Form Definition

Retrieves the complete structure and configuration of a specific feedback form, including all fields, sections, and their settings. Use this to understand what information you need to collect during your interview feedback process.

List Communication Templates

Retrieve all available email and message templates for candidate communication. This helps you quickly access pre-built templates to streamline your recruitment outreach and maintain consistent messaging.

List Feedback Form Definitions

Retrieve all feedback form templates available in your Ashby organization to understand what interview feedback forms and scorecards are set up for your hiring process.

Get User Info

Fetch comprehensive details about a team member including their name, email, role, and access permissions. Use this to understand who has what responsibilities and access levels in your organization.

List Users

Retrieve all team members in your organization along with their roles and access levels. Use this to maintain visibility over your recruitment team and manage permissions.

Search Users

Find team members in your Ashby organization by searching their email address, retrieving their ID, name, role, and current status.