> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ashby

> How to set up the Ashby connector, plus the actions and events that are available.

![Ashby](https://stackone-logos.com/api/ashby/filled/svg)

v3.1.0[See changelog](https://docs.stackone.com/connectors/ashby/changelog.md)

[138 actions](#actions) · [30 events](#events) · 1 auth method

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/ashby/guides/connector-profile/api-key.md)
>
> Uses an API key created in Ashby. Access is limited to the permissions selected when the key is created.

Optionally, configure receiving Events for Ashby into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/ashby/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/ashby/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

apiKeysWebhooksRead

apiKeysWebhooksWrite

approvalsRead

approvalsWrite

auditLogsRead

candidatesRead

candidatesWrite

hiringProcessRead

hiringProcessWrite

interviewsRead

interviewsWrite

jobsRead

jobsWrite

offersRead

offersWrite

organizationRead

organizationWrite

reportsRead

No scopes found

138 actions

ActionDescriptionRequired scopes

List Departments`ashby_list_departments`

Retrieve a paginated list of departments with cursor-based pagination and incremental sync support.

`organizationRead`

Get Department`ashby_get_department`

Get details for a single department

`organizationRead`

Create Department`ashby_create_department`

Create a new department in the organization

`organizationWrite`

Update Department`ashby_update_department`

Update an existing department's details

`organizationWrite`

Archive Department`ashby_archive_department`

Archive a department

`organizationWrite`

Restore Department`ashby_restore_department`

Restore an archived department

`organizationWrite`

Move Department`ashby_move_department`

Move a department to another parent

`organizationWrite`

List Interview Plans`ashby_list_interview_plans`

Retrieve a paginated list of interview plans with cursor-based pagination and incremental sync support.

`interviewsRead`

List Job Boards`ashby_list_job_boards`

List job boards configured in Ashby

`jobsRead`

List Job Postings`ashby_list_job_postings`

List job postings that are available on job boards

`jobsRead`

Get Job Posting`ashby_get_job_posting`

Get details for a single job posting

`jobsRead`

Update Job Posting`ashby_update_job_posting`

Update selected fields on an existing job posting

`jobsWrite`

Create Job`ashby_create_job`

Create a new job in Ashby

`jobsWrite`

Update Job`ashby_update_job`

Update an existing job by ID

`jobsWrite`

Update Job Compensation`ashby_update_job_compensation`

Update compensation tiers for an existing job

`jobsWrite`

List Job Templates`ashby_list_job_templates`

Retrieve a paginated list of job templates with cursor-based pagination and incremental sync support.

`jobsRead`

Set Job Status`ashby_set_job_status`

Set the status of a job by ID

`jobsWrite`

Search Jobs`ashby_search_jobs`

Search for jobs by title or requisition ID

`jobsRead`

List Jobs`ashby_list_jobs`

List all open, closed, and archived jobs

`jobsRead`

Get Job`ashby_get_job`

Get details about a single job by ID

`jobsRead`

List Locations`ashby_list_locations`

Retrieve a paginated list of locations with cursor-based pagination and incremental sync support.

`organizationRead`

Create Location`ashby_create_location`

Create a new location or location hierarchy

`organizationWrite`

Get Location`ashby_get_location`

Get details for a single location

`organizationRead`

Archive Location`ashby_archive_location`

Archive a location or location hierarchy

`organizationWrite`

Restore Location`ashby_restore_location`

Restore an archived location or location hierarchy

`organizationWrite`

Move Location`ashby_move_location`

Move a location within the location hierarchy

`organizationWrite`

Update Location Address`ashby_update_location_address`

Update the address of a location or location hierarchy

`organizationWrite`

Update Location Name`ashby_update_location_name`

Update the name of a location

`organizationWrite`

Update Location Workplace Type`ashby_update_location_workplace_type`

Update the workplace type of a location

`organizationWrite`

Update Location External Name`ashby_update_location_external_name`

Update a location's external (candidate-facing) name

`organizationWrite`

Get Opening`ashby_get_opening`

Retrieve details for a specific opening, including status, associated jobs, locations, and key metadata. Useful for powe...

`jobsRead`

List Openings`ashby_list_openings`

Retrieve a paginated list of openings with cursor-based pagination and incremental sync support.

`jobsRead`

Search Openings`ashby_search_openings`

Search openings by identifier.

`jobsRead`

Create Opening`ashby_create_opening`

Create a new opening/requisition with the provided configuration (title, department, locations, target dates, and metada...

`jobsWrite`

Add Job To Opening`ashby_add_job_to_opening`

Attach an existing job to an opening/requisition.

`jobsWrite`

Remove Job From Opening`ashby_remove_job_from_opening`

Remove an associated job from an opening/requisition.

`jobsWrite`

Update Opening`ashby_update_opening`

Update fields on an existing opening (e.g., title, state, targets, locations).

`jobsWrite`

Add Location To Opening`ashby_add_opening_location`

Add a location to an opening

`jobsWrite`

Remove Location From Opening`ashby_remove_opening_location`

Remove a location from an opening

`jobsWrite`

Set Opening State`ashby_set_opening_state`

Set the state of an opening

`jobsWrite`

Set Opening Archived Status`ashby_set_opening_archived`

Set the archived state of an opening

`jobsWrite`

Get File`ashby_get_file`

Retrieve metadata and download information for an uploaded file (e.g., resume or attachment) using its file ID.

`candidatesRead`

List Candidates`ashby_list_candidates`

Retrieve a paginated list of candidates with cursor-based pagination and incremental sync support.

`candidatesRead`

Get Candidate (by ID)`ashby_get_candidate_by_id`

Retrieve detailed information for a single candidate by ID.

`candidatesRead`

Get Candidate (by External Mapping ID)`ashby_get_candidate_by_external_mapping_id`

Retrieve detailed information for a single candidate by external mapping ID.

`candidatesRead`

Search Candidates`ashby_search_candidates`

Search candidates by email and/or name; results limited to 100.

`candidatesRead`

Create Candidate`ashby_create_candidate`

Create a new candidate profile with basic contact information and optional metadata.

`candidatesWrite`

Update Candidate`ashby_update_candidate`

Update candidate profile fields or custom data.

`candidatesWrite`

Upload Candidate Resume`ashby_upload_candidate_resume_complete`

Complete 3-step workflow to upload and parse a candidate's resume with automatic profile population

`candidatesWrite`

Upload Candidate File`ashby_upload_candidate_file_complete`

Complete 3-step workflow to upload and attach any file type to a candidate's profile without parsing

`candidatesWrite`

Add Candidate Tag`ashby_add_candidate_tag`

Add a tag to a candidate.

`candidatesWrite`

Add Candidate To Project`ashby_add_candidate_project`

Associate a candidate with a recruiting project.

`candidatesWrite`

Anonymize Candidate`ashby_anonymize_candidate`

Anonymize a candidate record for privacy/compliance purposes.

`candidatesWrite`

List Candidate Notes`ashby_list_candidate_notes`

Retrieve a paginated list of candidate notes with cursor-based pagination and incremental sync support.

`candidatesRead`

Create Candidate Note As String`ashby_create_candidate_note_as_string`

Add a note to a candidate profile using plain string content (text or HTML).

`candidatesWrite`

Create Candidate Note As Object`ashby_create_candidate_note_as_object`

Add a note to a candidate profile using structured object with explicit content type specification.

`candidatesWrite`

List Candidate Projects`ashby_list_candidate_projects`

Retrieve a paginated list of candidate projects with cursor-based pagination and incremental sync support.

`candidatesRead`

List Candidate Client Info`ashby_list_candidate_client_info`

Retrieve client-facing candidate info records with cursor-based pagination and incremental sync support.

`candidatesRead`

Add Completed Assessment To Candidate`ashby_add_assessment_to_candidate`

Add a completed assessment result to a candidate profile.

`candidatesWrite`

Remove Candidate Tag`ashby_remove_candidate_tag`

Remove a tag from a candidate

`candidatesWrite`

Remove Candidate From Project`ashby_remove_candidate_project`

Remove a candidate from a project

`candidatesWrite`

Add Candidate Email Message`ashby_add_email_message`

Add an email message to a candidate's profile timeline

`candidatesWrite`

List Candidate Tags`ashby_list_candidate_tags`

Retrieve a paginated list of candidate tags with cursor-based pagination and incremental sync support.

`hiringProcessRead`

Create Candidate Tag`ashby_create_candidate_tag`

Create a new candidate tag.

`hiringProcessWrite`

List Projects`ashby_list_projects`

Retrieve a paginated list of projects with cursor-based pagination and incremental sync support.

`candidatesRead`

Search Projects`ashby_search_projects`

Search projects by title (limited to 100 results).

`candidatesRead`

Get Project`ashby_get_project`

Get project details by ID.

`candidatesRead`

Get Application (by ID)`ashby_get_application_by_id`

Retrieve detailed information about a specific application.

`candidatesRead`

Get Application (by Submitted Form Instance ID)`ashby_get_application_by_submitted_form_instance_id`

Retrieve detailed information about a specific application.

`candidatesRead`

List Applications`ashby_list_applications`

Retrieve a paginated list of applications. The expand parameter only supports 'openings' — applicationFormSubmissions an...

`candidatesRead`

Create Application`ashby_create_application`

Create a new application for a candidate and job posting.

`candidatesWrite`

Update Application`ashby_update_application`

Update fields on an existing application.

`candidatesWrite`

Transfer Application`ashby_transfer_application`

Transfer an application to a different job.

`candidatesWrite`

Change Application Stage`ashby_change_application_stage`

Move an application to a new interview stage.

`candidatesWrite`

Change Application Source`ashby_change_application_source`

Update the source attribution for an application.

`candidatesWrite`

Update Application History`ashby_update_application_history`

Append history entries to an application.

`candidatesWrite`

List Application History`ashby_list_application_history`

Retrieve a paginated list of history events for an application with cursor-based pagination.

`candidatesRead`

Add Application Hiring Team Member`ashby_add_application_hiring_team_member`

Add a hiring team member to an application.

`candidatesWrite`

Remove Application Hiring Team Member`ashby_remove_application_hiring_team_member`

Remove a hiring team member from an application.

`candidatesWrite`

List Audit Log`ashby_list_audit_log`

List audit log entries for an organization, newest first. Use targetIds to filter by specific candidate, application, or...

`auditLogsRead`

List Interview Stages`ashby_list_interview_stages`

List interview stages with pagination to drive scheduling flows.

`interviewsRead`

Get Interview Stage`ashby_get_interview_stage`

Retrieve details for a specific interview stage.

`interviewsRead`

List Interview Stage Groups`ashby_list_interview_stage_groups`

List interview stage groups for pipeline configuration.

`interviewsRead`

List Interviewer Pools`ashby_list_interviewer_pools`

Retrieve a paginated list of interviewer pools with cursor-based pagination and incremental sync support.

`interviewsRead`

List Interview Events`ashby_list_interview_events`

List individual scheduled calendar events (the actual meetings between candidates and interviewers).

`interviewsRead`

List Interviews`ashby_list_interviews`

Retrieve a paginated list of interviews with cursor-based pagination and incremental sync support.

`interviewsRead`

Get Interview`ashby_get_interview`

Retrieve details for a specific interview.

`interviewsRead`

List Interview Schedules`ashby_list_interview_schedules`

Retrieve a paginated list of interview schedules with cursor-based pagination and incremental sync support.

`interviewsRead`

Create Interview Schedule`ashby_create_interview_schedule`

Create a new interview schedule for an application.

`interviewsWrite`

Update Interview Schedule`ashby_update_interview_schedule`

Update details of an interview schedule (time, participants, etc.).

`interviewsWrite`

Cancel Interview Schedule`ashby_cancel_interview_schedule`

Cancel a scheduled interview.

`interviewsWrite`

List Feedback Form Definitions`ashby_list_feedback_form_definitions`

Retrieve a paginated list of feedback form definitions with cursor-based pagination and incremental sync support.

`hiringProcessRead`

Get Feedback Form Definition`ashby_get_feedback_form_definition`

Retrieve details of a specific feedback form definition by ID.

`hiringProcessRead`

List Application Feedback`ashby_list_application_feedback`

Retrieve a paginated list of application feedback with cursor-based pagination and incremental sync support.

`candidatesRead`

Submit Application Feedback`ashby_submit_application_feedback`

Submit interview feedback for an application using a feedback form definition.

`candidatesWrite`

List Users`ashby_list_users`

Retrieve a paginated list of Ashby users. Use this to find users by name (search\_users only supports email lookup).

`organizationRead`

Get User`ashby_get_user`

Retrieve details for a specific user.

`organizationRead`

Search Users`ashby_search_users`

Search users by email address only. For finding users by name, use list\_users instead.

`organizationRead`

Get User Interviewer Settings`ashby_get_user_interviewer_settings`

Retrieve interviewer settings for a user.

`organizationRead`

Update User Interviewer Settings`ashby_update_user_interviewer_settings`

Update interviewer settings for a user including daily and weekly interview capacity limits.

`organizationWrite`

List Offers`ashby_list_offers`

Retrieve a paginated list of offers with cursor-based pagination and incremental sync support.

`offersRead`

Get Offer`ashby_get_offer`

Retrieve details of a specific offer.

`offersRead`

Create Offer`ashby_create_offer`

Create a new offer for an application with structured field submissions including compensation, start date, and custom f...

`offersWrite`

Start Offer Process`ashby_start_offer`

Start the offer process for an application (initializes an offer).

`offersWrite`

Update Offer`ashby_update_offer`

Update fields on an existing offer. Currency fields require an object with 'value' (number) and 'currencyCode' (e.g. 'US...

`offersWrite`

Approve Offer`ashby_approve_offer`

Approve an offer using offer.approve.

`offersWrite`

Start Offer Process`ashby_start_offer_process`

Start an offer process workflow for an application.

`offersWrite`

List Approvals`ashby_list_approvals`

Retrieve a paginated list of approvals with cursor-based pagination and incremental sync support.

`approvalsRead`

Update Approval Definition`ashby_update_approval_definition`

Update approval definitions for approval workflows.

`approvalsWrite`

Generate Report`ashby_generate_report`

Generate an asynchronous report.

`reportsRead`

Generate Report (Synchronous)`ashby_generate_report_synchronous`

Generate a synchronous report.

`reportsRead`

List Communication Templates`ashby_list_communication_templates`

List communication templates for messaging and notifications.

`hiringProcessRead`

Create Custom Field`ashby_create_custom_field`

Create a new custom field for applications, candidates, jobs, employees, projects, openings, or offers

`hiringProcessWrite`

List Custom Fields`ashby_list_custom_fields`

List all custom fields defined in your Ashby organization

`hiringProcessRead`

Get Custom Field`ashby_get_custom_field`

Get detailed information about a specific custom field by ID

`hiringProcessRead`

Set Custom Field Value`ashby_set_custom_field_value`

Set the value of a custom field for a specific object (application, candidate, job, or opening)

`candidatesWrite`

Set Custom Field Values (Batch)`ashby_set_custom_field_values`

Set values for multiple custom fields on an object in a single atomic operation

`candidatesWrite`

Update Custom Field Selectable Values`ashby_update_custom_field_selectable_values`

Update the selectable values (options) for ValueSelect or MultiValueSelect custom fields

`hiringProcessWrite`

List Sources`ashby_list_sources`

List candidate sources for attribution and reporting.

`hiringProcessRead`

List Source Tracking Links`ashby_list_source_tracking_links`

List tracking links for sources to support campaign attribution.

`hiringProcessRead`

Get Survey Form Definition`ashby_get_survey_form_definition`

Retrieve survey form definition details by ID.

`candidatesRead`

Create Survey Request`ashby_create_survey_request`

Create a survey request for a candidate.

`candidatesWrite`

List Survey Requests`ashby_list_survey_requests`

Retrieve a paginated list of survey requests with cursor-based pagination and incremental sync support.

`candidatesRead`

Create Survey Submission`ashby_create_survey_submission`

Submit survey responses for a candidate.

`candidatesWrite`

List Survey Submissions`ashby_list_survey_submissions`

Retrieve a paginated list of survey submissions with cursor-based pagination and incremental sync support.

`candidatesRead`

Create Webhook`ashby_create_webhook`

Create a webhook subscription.

`apiKeysWebhooksWrite`

Get Webhook`ashby_get_webhook`

Retrieve webhook details by ID.

`apiKeysWebhooksRead`

Update Webhook`ashby_update_webhook`

Update webhook configuration. At least one of enabled, requestUrl, or secretToken must be provided.

`apiKeysWebhooksWrite`

Delete Webhook`ashby_delete_webhook`

Delete a webhook subscription.

`apiKeysWebhooksWrite`

Get Referral Form`ashby_get_referral_form`

Retrieve the referral form definition for submitting referrals.

`candidatesRead`

Create Referral`ashby_create_referral`

Create a candidate referral record.

`candidatesWrite`

List Archive Reasons`ashby_list_archive_reasons`

List archive (rejection) reasons for applications.

`hiringProcessRead`

List Close Reasons`ashby_list_close_reasons`

List close reasons for jobs/openings.

`hiringProcessRead`

List Hiring Team Roles`ashby_list_hiring_team_roles`

List available hiring team roles for assignments.

`organizationRead`

Add Hiring Team Member To Application`ashby_add_hiring_team_member_to_application`

Add a user to an application's hiring team with a specified role.

`organizationWrite`

Add Hiring Team Member To Job`ashby_add_hiring_team_member_to_job`

Add a user to a job-level hiring team with a specified role.

`organizationWrite`

Add Hiring Team Member To Opening`ashby_add_hiring_team_member_to_opening`

Add a user to an opening-level hiring team with a specified role.

`organizationWrite`

List Brands`ashby_list_brands`

Retrieve a paginated list of brands with cursor-based pagination support.

`hiringProcessRead`

## Events

Tags

Select all
|
Clear

Applications

Candidates

Health Checks

Interviews

Jobs

Offers

Webhooks

No tags found

30 events

EventDescriptionTags

Active Check`ashby_webhook_active_check`

Answers Ashby's ping request, sent when a webhook is created, edited or re-enabled, and emits it as an event.

Health ChecksWebhooks

Application Submitted Webhook`ashby_webhook_application_submit`

Processes Ashby applicationSubmit webhook events.

ApplicationsWebhooks

Application Updated Webhook`ashby_webhook_application_update`

Processes Ashby applicationUpdate webhook events.

ApplicationsWebhooks

Candidate Stage Changed Webhook`ashby_webhook_candidate_stage_change`

Processes Ashby candidateStageChange webhook events.

ApplicationsWebhooks

Candidate Hired Webhook`ashby_webhook_candidate_hire`

Processes Ashby candidateHire webhook events.

ApplicationsWebhooks

Candidate Pushed to HRIS Webhook`ashby_webhook_push_to_hris`

Processes Ashby pushToHRIS webhook events.

ApplicationsWebhooks

Candidate Deleted Webhook`ashby_webhook_candidate_delete`

Processes Ashby candidateDelete webhook events.

CandidatesWebhooks

Candidate Merged Webhook`ashby_webhook_candidate_merge`

Processes Ashby candidateMerge webhook events.

CandidatesWebhooks

Candidate Recent Email Messages Updated Webhook`ashby_webhook_candidate_recent_email_messages_updated`

Processes Ashby candidateRecentEmailMessagesUpdated webhook events.

CandidatesWebhooks

Survey Submitted Webhook`ashby_webhook_survey_submit`

Processes Ashby surveySubmit webhook events.

CandidatesWebhooks

Interview Plan Transitioned Webhook`ashby_webhook_interview_plan_transition`

Processes Ashby interviewPlanTransition webhook events.

InterviewsWebhooks

Interview Schedule Created Webhook`ashby_webhook_interview_schedule_create`

Processes Ashby interviewScheduleCreate webhook events.

InterviewsWebhooks

Interview Schedule Updated Webhook`ashby_webhook_interview_schedule_update`

Processes Ashby interviewScheduleUpdate webhook events.

InterviewsWebhooks

Take Home Assignment Assigned Webhook`ashby_webhook_take_home_assignment_assigned`

Processes Ashby takeHomeAssignmentAssigned webhook events.

InterviewsWebhooks

Take Home Assignment Submitted Webhook`ashby_webhook_take_home_assignment_submitted`

Processes Ashby takeHomeAssignmentSubmitted webhook events.

InterviewsWebhooks

Take Home Assignment Completed Webhook`ashby_webhook_take_home_assignment_completed`

Processes Ashby takeHomeAssignmentCompleted webhook events.

InterviewsWebhooks

Take Home Assignment Cancelled Webhook`ashby_webhook_take_home_assignment_cancelled`

Processes Ashby takeHomeAssignmentCancelled webhook events.

InterviewsWebhooks

Job Created Webhook`ashby_webhook_job_create`

Processes Ashby jobCreate webhook events.

JobsWebhooks

Job Updated Webhook`ashby_webhook_job_update`

Processes Ashby jobUpdate webhook events.

JobsWebhooks

Job Posting Published Webhook`ashby_webhook_job_posting_publish`

Processes Ashby jobPostingPublish webhook events.

JobsWebhooks

Job Posting Updated Webhook`ashby_webhook_job_posting_update`

Processes Ashby jobPostingUpdate webhook events.

JobsWebhooks

Job Posting Unpublished Webhook`ashby_webhook_job_posting_unpublish`

Processes Ashby jobPostingUnpublish webhook events.

JobsWebhooks

Job Posting Deleted Webhook`ashby_webhook_job_posting_delete`

Processes Ashby jobPostingDelete webhook events.

JobsWebhooks

Opening Created Webhook`ashby_webhook_opening_create`

Processes Ashby openingCreate webhook events.

JobsWebhooks

Opening Updated Webhook`ashby_webhook_opening_update`

Processes Ashby openingUpdate webhook events.

JobsWebhooks

Opening Deleted Webhook`ashby_webhook_opening_delete`

Processes Ashby openingDelete webhook events.

JobsWebhooks

Offer Created Webhook`ashby_webhook_offer_create`

Processes Ashby offerCreate webhook events.

OffersWebhooks

Offer Updated Webhook`ashby_webhook_offer_update`

Processes Ashby offerUpdate webhook events.

OffersWebhooks

Offer Deleted Webhook`ashby_webhook_offer_delete`

Processes Ashby offerDelete webhook events.

OffersWebhooks

Signature Request Updated Webhook`ashby_webhook_signature_request_update`

Processes Ashby signatureRequestUpdate webhook events.

OffersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.