Skip to main content
Ashby
Ashby
137 actions · 1 auth method
PreviewATS

Authentication

Public API

API key authentication. Requires Admin privileges to generate a key.Guides: Connector Profile, Link Account
Actions
|
137 actions
Action
Description
Required scopes
List Departments
Retrieve a paginated list of departments with cursor-based pagination and incremental sync support.
Get Department
Get details for a single department
Create Department
Create a new department in the organization
Update Department
Update an existing department’s details
Archive Department
Archive a department
Restore Department
Restore an archived department
Move Department
Move a department to another parent
List Interview Plans
Retrieve a paginated list of interview plans with cursor-based pagination and incremental sync support.
List Job Boards
List job boards configured in Ashby
List Job Postings
List job postings that are available on job boards
Get Job Posting
Get details for a single job posting
Update Job Posting
Update selected fields on an existing job posting
Create Job
Create a new job in Ashby
Update Job
Update an existing job by ID
Update Job Compensation
Update compensation tiers for an existing job
List Job Templates
Retrieve a paginated list of job templates with cursor-based pagination and incremental sync support.
Set Job Status
Set the status of a job by ID
Search Jobs
Search for jobs by title or requisition ID
List Jobs
List all open, closed, and archived jobs
Get Job
Get details about a single job by ID
List Locations
Retrieve a paginated list of locations with cursor-based pagination and incremental sync support.
Create Location
Create a new location or location hierarchy
Get Location
Get details for a single location
Archive Location
Archive a location or location hierarchy
Restore Location
Restore an archived location or location hierarchy
Move Location
Move a location within the location hierarchy
Update Location Address
Update the address of a location or location hierarchy
Update Location Name
Update the name of a location
Update Location Workplace Type
Update the workplace type of a location
Update Location External Name
Update a location’s external (candidate-facing) name
Get Opening
Retrieve details for a specific opening, including status, associated jobs, locations, and key metadata. Useful for powe…
List Openings
Retrieve a paginated list of openings with cursor-based pagination and incremental sync support.
Search Openings
Search openings by identifier.
Create Opening
Create a new opening/requisition with the provided configuration (title, department, locations, target dates, and metada…
Add Job To Opening
Attach an existing job to an opening/requisition.
Remove Job From Opening
Remove an associated job from an opening/requisition.
Update Opening
Update fields on an existing opening (e.g., title, state, targets, locations).
Add Location To Opening
Add a location to an opening
Remove Location From Opening
Remove a location from an opening
Set Opening State
Set the state of an opening
Set Opening Archived Status
Set the archived state of an opening
Get File
Retrieve metadata and download information for an uploaded file (e.g., resume or attachment) using its file ID.
List Candidates
Retrieve a paginated list of candidates with cursor-based pagination and incremental sync support.
Get Candidate (by ID)
Retrieve detailed information for a single candidate by ID.
Get Candidate (by External Mapping ID)
Retrieve detailed information for a single candidate by external mapping ID.
Search Candidates
Search candidates by email and/or name; results limited to 100.
Create Candidate
Create a new candidate profile with basic contact information and optional metadata.
Update Candidate
Update candidate profile fields or custom data.
Upload Candidate Resume
Complete 3-step workflow to upload and parse a candidate’s resume with automatic profile population
Upload Candidate File
Complete 3-step workflow to upload and attach any file type to a candidate’s profile without parsing
Add Candidate Tag
Add a tag to a candidate.
Add Candidate To Project
Associate a candidate with a recruiting project.
Anonymize Candidate
Anonymize a candidate record for privacy/compliance purposes.
List Candidate Notes
Retrieve a paginated list of candidate notes with cursor-based pagination and incremental sync support.
Create Candidate Note As String
Add a note to a candidate profile using plain string content (text or HTML).
Create Candidate Note As Object
Add a note to a candidate profile using structured object with explicit content type specification.
List Candidate Projects
Retrieve a paginated list of candidate projects with cursor-based pagination and incremental sync support.
List Candidate Client Info
Retrieve client-facing candidate info records with cursor-based pagination and incremental sync support.
Add Completed Assessment To Candidate
Add a completed assessment result to a candidate profile.
Remove Candidate Tag
Remove a tag from a candidate
Remove Candidate From Project
Remove a candidate from a project
Add Candidate Email Message
Add an email message to a candidate’s profile timeline
List Candidate Tags
Retrieve a paginated list of candidate tags with cursor-based pagination and incremental sync support.
Create Candidate Tag
Create a new candidate tag.
List Projects
Retrieve a paginated list of projects with cursor-based pagination and incremental sync support.
Search Projects
Search projects by title (limited to 100 results).
Get Project
Get project details by ID.
Get Application (by ID)
Retrieve detailed information about a specific application.
Get Application (by Submitted Form Instance ID)
Retrieve detailed information about a specific application.
List Applications
Retrieve a paginated list of applications with cursor-based pagination and incremental sync support.
Create Application
Create a new application for a candidate and job posting.
Update Application
Update fields on an existing application.
Transfer Application
Transfer an application to a different job.
Change Application Stage
Move an application to a new interview stage.
Change Application Source
Update the source attribution for an application.
Update Application History
Append history entries to an application.
List Application History
Retrieve a paginated list of history events for an application with cursor-based pagination.
Add Application Hiring Team Member
Add a hiring team member to an application.
Remove Application Hiring Team Member
Remove a hiring team member from an application.
List Interview Stages
List interview stages with pagination to drive scheduling flows.
Get Interview Stage
Retrieve details for a specific interview stage.
List Interview Stage Groups
List interview stage groups for pipeline configuration.
List Interviewer Pools
Retrieve a paginated list of interviewer pools with cursor-based pagination and incremental sync support.
List Interview Events
List individual scheduled calendar events (the actual meetings between candidates and interviewers).
List Interviews
Retrieve a paginated list of interviews with cursor-based pagination and incremental sync support.
Get Interview
Retrieve details for a specific interview.
List Interview Schedules
Retrieve a paginated list of interview schedules with cursor-based pagination and incremental sync support.
Create Interview Schedule
Create a new interview schedule for an application.
Update Interview Schedule
Update details of an interview schedule (time, participants, etc.).
Cancel Interview Schedule
Cancel a scheduled interview.
List Feedback Form Definitions
Retrieve a paginated list of feedback form definitions with cursor-based pagination and incremental sync support.
Get Feedback Form Definition
Retrieve details of a specific feedback form definition by ID.
List Application Feedback
Retrieve a paginated list of application feedback with cursor-based pagination and incremental sync support.
Submit Application Feedback
Submit interview feedback for an application using a feedback form definition.
List Users
Retrieve a paginated list of Ashby users with cursor-based pagination and incremental sync support.
Get User
Retrieve details for a specific user.
Search Users
Search users by email.
Get User Interviewer Settings
Retrieve interviewer settings for a user.
Update User Interviewer Settings
Update interviewer settings for a user.
List Offers
Retrieve a paginated list of offers with cursor-based pagination and incremental sync support.
Get Offer
Retrieve details of a specific offer.
Create Offer
Create a new offer for an application with structured field submissions including compensation, start date, and custom f…
Start Offer Process
Start the offer process for an application (initializes an offer).
Update Offer
Update fields on an existing offer.
Approve Offer
Approve an offer using offer.approve.
Start Offer Process
Start an offer process workflow for an application.
List Approvals
Retrieve a paginated list of approvals with cursor-based pagination and incremental sync support.
Update Approval Definition
Update approval definitions for approval workflows.
Generate Report
Generate an asynchronous report.
Generate Report (Synchronous)
Generate a synchronous report.
List Communication Templates
List communication templates for messaging and notifications.
Create Custom Field
Create a new custom field for applications, candidates, jobs, employees, projects, openings, or offers
List Custom Fields
List all custom fields defined in your Ashby organization
Get Custom Field
Get detailed information about a specific custom field by ID
Set Custom Field Value
Set the value of a custom field for a specific object (application, candidate, job, or opening)
Set Custom Field Values (Batch)
Set values for multiple custom fields on an object in a single atomic operation
Update Custom Field Selectable Values
Update the selectable values (options) for ValueSelect or MultiValueSelect custom fields
List Sources
List candidate sources for attribution and reporting.
List Source Tracking Links
List tracking links for sources to support campaign attribution.
Get Survey Form Definition
Retrieve survey form definition details by ID.
Create Survey Request
Create a survey request for a candidate.
List Survey Requests
Retrieve a paginated list of survey requests with cursor-based pagination and incremental sync support.
Create Survey Submission
Submit survey responses for a candidate.
List Survey Submissions
Retrieve a paginated list of survey submissions with cursor-based pagination and incremental sync support.
Create Webhook
Create a webhook subscription.
Get Webhook
Retrieve webhook details by ID.
Update Webhook
Update webhook configuration. At least one of enabled, requestUrl, or secretToken must be provided.
Delete Webhook
Delete a webhook subscription.
Get Referral Form
Retrieve the referral form definition for submitting referrals.
Create Referral
Create a candidate referral record.
List Archive Reasons
List archive (rejection) reasons for applications.
List Close Reasons
List close reasons for jobs/openings.
List Hiring Team Roles
List available hiring team roles for assignments.
Add Hiring Team Member To Application
Add a user to an application’s hiring team with a specified role.
Add Hiring Team Member To Job
Add a user to a job-level hiring team with a specified role.
Add Hiring Team Member To Opening
Add a user to an opening-level hiring team with a specified role.
List Brands
Retrieve a paginated list of brands with cursor-based pagination support.

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/ashby/filled/png

Connector Profile

Ashby - Public API
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/ashby/filled/png

Link Account

Ashby - Public API
4

Use Actions

Invoke actions using one of the methods below: