> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Ashby

> Ashby delivers an applicant tracking system for modern teams, offering features like job postings, candidate management, and data-driven hiring insights to streamline the recruitment process

![Ashby logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/ashby.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=1e3277bef771289e0ab1d7cb372f9e55)

* **Category:** hr talent & recruitment
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 125
* **Triggers:** 28
* **Slug:** `ASHBY`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Candidate to Project
>
> **Slug:** `ASHBY_ADD_CANDIDATE_PROJECT`
>
> Add a candidate to a project in Ashby. Projects are sourcing initiatives or recruiting campaigns used to organize and track candidate pipelines. Use this to associate candidates with specific sourcing efforts. Common use cases: - Adding sourced candidates to recruiting campaigns - Organizing candidates by sourcing channel or initiative - Tracking candidates in specific hiring projects Requires candidatesWrite permission. Returns the updated candidate object on success, or error details if the candidate or project is not found.
>
> #### Input Parameters
>
> **projectId** `string` *required*
>
> UUID of the project to associate the candidate with. Use LIST\_PROJECTS or SEARCH\_PROJECTS to find project IDs. Projects are sourcing initiatives or recruiting campaigns.
>
> **candidateId** `string` *required*
>
> UUID of the candidate to add to the project. Use LIST\_CANDIDATES or SEARCH\_CANDIDATES to find candidate IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Candidate Tag
>
> **Slug:** `ASHBY_ADD_CANDIDATE_TAG`
>
> Add a tag to a candidate in Ashby. Use this to categorize and organize candidates with existing tags from the system. This action allows you to apply labels/tags to candidates for filtering, searching, and organizational purposes. Tags must already exist in the system - use LIST\_CANDIDATE\_TAGS to view available tags or CREATE\_CANDIDATE\_TAG to create new ones. The response includes the full updated candidate object when successful, showing the newly added tag in the candidate's tags array. If a candidate already has the tag, the operation will still succeed idempotently.
>
> #### Input Parameters
>
> **tagId** `string` *required*
>
> The ID of the tag to add to the candidate. Use LIST\_CANDIDATE\_TAGS to get available tag IDs, or CREATE\_CANDIDATE\_TAG to create a new tag.
>
> **candidateId** `string` *required*
>
> The unique identifier of the candidate. Use LIST\_CANDIDATES or GET\_CANDIDATE\_INFO to obtain valid candidate IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Completed Assessment to Candidate
>
> **Slug:** `ASHBY_ADD_COMPLETED_TO_CANDIDATE_ASSESSMENT`
>
> Add a completed partner assessment to an Ashby candidate. Supply the candidate and partner UUIDs, the partner's assessment identifiers, name, result and at least one metadata entry. The completion timestamp is in milliseconds since the Unix epoch, not seconds. This records an already completed assessment; it does not launch a new assessment or fetch result URLs. Requires candidatesWrite permission.
>
> #### Input Parameters
>
> **partnerId** `string` *required*
>
> The UUID of the partner adding the assessment.
>
> **timestamp** `integer` *required*
>
> When the assessment was completed, in milliseconds since the Unix epoch.
>
> **assessment** `object` *required*
>
> The completed assessment to add.
>
> **candidateId** `string` *required*
>
> The candidate UUID to add the completed assessment to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Existing Email Message to Candidate
>
> **Slug:** `ASHBY_ADD_EMAIL_MESSAGE_CANDIDATE`
>
> Attach an existing email message from a partner system to an Ashby candidate. Imports an email record; does not send or deliver email. The partner message ID must be unique per API key. Requires candidatesWrite permission. Creating or viewing private emails additionally requires the API key permission "Allow access to non-offer private fields?".
>
> #### Input Parameters
>
> **cc** `string`
>
> CC recipients.
>
> **to** `string` *required*
>
> The recipient email address.
>
> **body** `string` *required*
>
> The HTML body of the existing email.
>
> **from** `string` *required*
>
> The sender email address.
>
> **sentAt** `string`
>
> When the email was sent. Defaults to the current time.
>
> **userId** `string`
>
> Ashby user UUID to associate with this email. Defaults to the API key user.
>
> **subject** `string` *required*
>
> The email subject line.
>
> **threadId** `string`
>
> Thread identifier to group messages. Defaults to emailProviderEmailId.
>
> **isPrivate** `boolean`
>
> Whether to mark the imported email private. Defaults to false. Creating and viewing private emails requires the API key permission "Allow access to non-offer private fields?".
>
> **messageUrl** `string`
>
> URL to view the message in the partner application.
>
> **candidateId** `string` *required*
>
> UUID of the candidate to attach this existing email to.
>
> **messageIdHeader** `string`
>
> RFC 5322 message identifier.
>
> **emailProviderEmailId** `string` *required*
>
> Message identifier in the partner system. Must be unique per API key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Hiring Team Member
>
> **Slug:** `ASHBY_ADD_HIRING_TEAM_MEMBER`
>
> 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.
>
> #### Input Parameters
>
> **jobId** `string`
>
> ID of the job to add team member to. Either applicationId, jobId, or openingId must be provided, but not multiple.
>
> **roleId** `string` *required*
>
> ID of the hiring team role to assign to the user. This must be a valid UUID from your organization's hiring team roles.
>
> **openingId** `string`
>
> ID of the opening to add team member to. Either applicationId, jobId, or openingId must be provided, but not multiple.
>
> **teamMemberId** `string` *required*
>
> ID of the Ashby user to add to the hiring team.
>
> **applicationId** `string`
>
> ID of the application to add team member to. Either applicationId, jobId, or openingId must be provided, but not multiple.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Hiring Team Member to Application
>
> **Slug:** `ASHBY_ADD_HIRING_TEAM_MEMBER_APPLICATION`
>
> Add an Ashby user to the hiring team of a specific application. Assigns the user the specified hiring team role at the application level, not at the job or opening level. Requires candidatesWrite permission. Returns the assigned member's user ID, name, email, and role.
>
> #### Input Parameters
>
> **roleId** `string` *required*
>
> The UUID of the hiring team role to assign.
>
> **teamMemberId** `string` *required*
>
> The UUID of the Ashby user to assign the role to.
>
> **applicationId** `string` *required*
>
> The UUID of the application to assign the user a role on.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add User to Interviewer Pool
>
> **Slug:** `ASHBY_ADD_INTERVIEWER_POOL_USER`
>
> Add a user to an interviewer pool. Use this to assign interviewers to interview pools for scheduling and coordination. Requires the hiringProcessMetadataWrite permission.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> UUID of the user to add to the interviewer pool
>
> **interviewerPoolId** `string` *required*
>
> UUID of the interviewer pool to add the user to
>
> **interviewerPoolTrainingPathStageId** `string`
>
> Optional UUID of the training path stage to assign the user to within the interviewer pool. If provided, the user will be added as a trainee at this stage.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Opening Job
>
> **Slug:** `ASHBY_ADD_OPENING_JOB`
>
> Adds a job to an opening (job requisition) in Ashby ATS. An opening represents a position to be filled, while a job defines the role details. This action associates an existing job with an existing opening, allowing multiple jobs to be linked to a single opening. Use this when you need to add job definitions to an opening or when creating multi-role requisitions. Requires the jobsWrite permission. On success, returns the updated opening with the job added to its jobIds array. On failure, returns error details with specific error codes.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The unique identifier of the job to be added to the opening
>
> **openingId** `string` *required*
>
> The unique identifier of the opening to add the job to
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Opening Location
>
> **Slug:** `ASHBY_ADD_OPENING_LOCATION`
>
> 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.
>
> #### Input Parameters
>
> **openingId** `string` *required*
>
> The UUID of the opening to add the location to
>
> **locationId** `string` *required*
>
> The UUID of the location to add to the opening
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Sequence
>
> **Slug:** `ASHBY_ADD_SEQUENCE`
>
> Enroll a candidate in a reusable sourcing sequence. Requires sourcingWrite. start=false creates an editable draft; start=true validates and attempts to start immediately, potentially sending outreach. Inspect startResult: blocked validation or required actions return NotStarted with status Blocked even when success is true. applicationId fixes the application used for token resolution. Optional from.email must be a Primary, PersonalAlias or OrganizationAlias from emailSender.list for the same acting user. NoReply senders are always rejected, including custom-domain no-reply addresses. x-on-behalf-of requests create a draft owned by that user. A duplicate draft for the same candidate, template and actor returns sequence\_draft\_already\_exists; errorInfo.meta.existingSequenceId identifies it. This action does not perform sender discovery or start retries.
>
> #### Input Parameters
>
> **from** `object`
>
> Optional sender address for every email stage; must be available to the acting user.
>
> **start** `boolean` *required*
>
> False creates an editable draft; true validates and attempts to start immediately.
>
> **candidateId** `string` *required*
>
> The UUID of the candidate to enroll.
>
> **applicationId** `string`
>
> Optional candidate application UUID fixed for token resolution.
>
> **sequenceTemplateId** `string` *required*
>
> The reusable sourcing sequence template UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Anonymize Candidate
>
> **Slug:** `ASHBY_ANONYMIZE_CANDIDATE`
>
> 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.
>
> #### Input Parameters
>
> **candidateId** `string` *required*
>
> The unique identifier of the candidate to anonymize. All of the candidate's applications must be in the archived or hired state.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Approve Offer
>
> **Slug:** `ASHBY_APPROVE_OFFER`
>
> Approve an offer or a specific step in its approval process using Ashby's Force Approve behavior, which allows an admin to override the approval process. Requires offersWrite permission.
>
> #### Input Parameters
>
> **userId** `string`
>
> Unique identifier (UUID) of the user performing the step-specific approval. Required when approving a specific step (must be used with approvalStepId).
>
> **offerId** `string` *required*
>
> Unique identifier (UUID) for the offer to approve. Required for all approval operations.
>
> **approvalStepId** `string`
>
> Unique identifier (UUID) for a particular approval step. Required when approving a specific step (must be used with userId).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Archive Candidate Tag
>
> **Slug:** `ASHBY_ARCHIVE_CANDIDATE_TAG`
>
> Archive an Ashby candidate tag definition by UUID. Requires hiringProcessMetadataWrite permission. This archives the tag itself; use the candidate tag removal action to remove a tag from an individual candidate. Returns the tag's ID, title, and archived status.
>
> #### Input Parameters
>
> **tagId** `string` *required*
>
> The UUID of the candidate tag to archive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Archive Department
>
> **Slug:** `ASHBY_ARCHIVE_DEPARTMENT`
>
> Archive a department by its unique identifier. Archiving a department marks it as inactive while preserving all its data and historical records. Archived departments are excluded from active department lists by default but can be restored later using the restore department action. This action is idempotent - archiving an already archived department will succeed and return the same result. Required permission: organizationWrite
>
> #### Input Parameters
>
> **departmentId** `string` *required*
>
> The unique identifier of the department to archive
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Archive Interviewer Pool
>
> **Slug:** `ASHBY_ARCHIVE_INTERVIEWER_POOL`
>
> Archive an interviewer pool in Ashby. This marks the pool as archived, making it unavailable for new interview assignments while preserving historical data. Use this when an interviewer pool is no longer needed (e.g., for deprecated roles or outdated interview formats). The operation is idempotent - archiving an already archived pool will succeed without errors. Requires the hiringProcessMetadataWrite permission. To restore an archived pool, use the ASHBY\_RESTORE\_INTERVIEWER\_POOL action.
>
> #### Input Parameters
>
> **interviewerPoolId** `string` *required*
>
> The unique identifier (UUID) of the interviewer pool to archive. You can get this ID from LIST\_INTERVIEWER\_POOLS or GET\_INTERVIEWER\_POOL\_INFO actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Archive Location
>
> **Slug:** `ASHBY_ARCHIVE_LOCATION`
>
> Archives a location or location hierarchy in Ashby. When archived, the location is marked as inactive (isArchived=true) and typically becomes unavailable for new job postings or assignments. The operation is idempotent - archiving an already archived location succeeds without error. Requires the organizationWrite permission. Common use cases: - Decommissioning office locations that are no longer in use - Removing obsolete location entries from active use - Managing location lifecycle when restructuring office locations Note: Use restore\_location to unarchive a location if needed.
>
> #### Input Parameters
>
> **locationId** `string` *required*
>
> The unique identifier (UUID) of the location to archive. Can be obtained from list\_locations or other location endpoints.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Archive Project
>
> **Slug:** `ASHBY_ARCHIVE_PROJECT`
>
> Archive an Ashby project by UUID and return the updated project. Already archived projects succeed. Candidate memberships, history, authorship, confidentiality, descriptions and custom-field values are preserved; this does not permanently delete projects or candidates. Requires projectsWrite and an effective actor authorized to edit the project, including on-behalf-of requests.
>
> #### Input Parameters
>
> **projectId** `string` *required*
>
> The UUID of the project to archive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Interview Schedule
>
> **Slug:** `ASHBY_CANCEL_INTERVIEW_SCHEDULE`
>
> Cancel an Ashby interview schedule by UUID. Requires interviewsWrite. Optionally specify whether the schedule can be rescheduled using allowReschedule. Returns the updated schedule, including its status and interview events.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The UUID of the interview schedule to cancel.
>
> **allowReschedule** `boolean`
>
> Whether this interview schedule can be rescheduled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Sequence
>
> **Slug:** `ASHBY_CANCEL_SEQUENCE`
>
> Cancel a running sourcing sequence (campaign) for a candidate in Ashby. Requires either candidatesWrite or sourcingWrite permission. The only supported cancellation reason is booked\_meeting, also the default when omitted. Returns the cancelled sequence ID.
>
> #### Input Parameters
>
> **reason** `string`
>
> The reason for cancelling the sequence. Only booked\_meeting is supported and is the provider default.
>
> **sequenceId** `string` *required*
>
> The UUID of the sequence to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Change Application Source
>
> **Slug:** `ASHBY_CHANGE_APPLICATION_SOURCE`
>
> Change the source attribution of an application. Use this to update which source and user should be credited for bringing in the candidate.
>
> #### Input Parameters
>
> **sourceId** `string` *required*
>
> The ID of the source to assign to the application
>
> **applicationId** `string` *required*
>
> The unique identifier of the application to update
>
> **creditedToUserId** `string`
>
> The ID of the user to credit for sourcing this application
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Change Application Stage
>
> **Slug:** `ASHBY_CHANGE_APPLICATION_STAGE`
>
> Move an application to a different interview stage in the hiring pipeline. Use this to: - Advance candidates to the next interview stage (e.g., from "Application Review" to "First Round") - Move candidates to any stage within their job's interview plan (forward or backward) - Archive applications by moving to an Archived stage (requires archiveReasonId) - Move to Offer or Hired stages when progressing candidates Important: The interview stage must belong to the same interview plan as the application's job. Use LIST\_INTERVIEW\_STAGES with the application's job interview plan ID to get valid stage options.
>
> #### Input Parameters
>
> **applicationId** `string` *required*
>
> The unique UUID of the application to update (obtain from LIST\_APPLICATIONS or GET\_APPLICATION\_INFO)
>
> **archiveReasonId** `string`
>
> Archive reason UUID - REQUIRED when moving to an Archived interview stage type. Optional for all other stage types. Obtain from LIST\_ARCHIVE\_REASONS.
>
> **interviewStageId** `string` *required*
>
> The UUID of the target interview stage to move the application to (obtain from LIST\_INTERVIEW\_STAGES for the application's job interview plan)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Application
>
> **Slug:** `ASHBY_CREATE_APPLICATION`
>
> Create a new job application by associating a candidate with a job opening in Ashby ATS. Use this action to: - Add a candidate to a job's hiring pipeline and interview process - Track the source of the application (referral, job board, etc.) - Credit a user (recruiter/referrer) for bringing in the candidate - Place the candidate directly into a specific interview stage (optional) The created application will automatically be assigned to the job's hiring team and start tracking the candidate's progress through the interview stages. Required: candidateId and jobId must reference existing entities in Ashby.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> UUID of the job position to apply the candidate to. Must be an existing job ID obtained from job listing endpoints.
>
> **sourceId** `string`
>
> UUID of the source that referred or brought in this candidate (e.g., LinkedIn, Referral, Job Board). Optional - if not provided, the application will have no associated source.
>
> **candidateId** `string` *required*
>
> UUID of the candidate to create an application for. Must be an existing candidate ID obtained from candidate creation or listing endpoints.
>
> **creditedToUserId** `string`
>
> UUID of the user who should receive credit for this application (e.g., recruiter or referrer). Optional - if not provided, no user will be credited.
>
> **interviewStageId** `string`
>
> UUID of the interview stage to initially place the application in. Must be a valid stage from the job's interview plan. Optional - if not provided, the candidate will be placed in the default first stage (typically 'New Lead').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Application Feedback Request
>
> **Slug:** `ASHBY_CREATE_APPLICATION_FEEDBACK_REQUEST`
>
> Request feedback on an application without scheduling an interview. Requires application, interview, and interviewer user IDs. The interview must be configured to request feedback. Use the returned interviewEventId with applicationFeedback.submit to complete the request. Requires candidatesWrite.
>
> #### Input Parameters
>
> **interviewId** `string` *required*
>
> The associated interview ID. The interview must be configured to request feedback.
>
> **applicationId** `string` *required*
>
> The application to request feedback for.
>
> **interviewerUserId** `string` *required*
>
> The user to request feedback from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Candidate
>
> **Slug:** `ASHBY_CREATE_CANDIDATE`
>
> Create a new candidate in the system. Use this to add candidates with their contact information and social profiles before applying them to jobs.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Full name of the candidate
>
> **email** `string`
>
> Primary email address of the candidate
>
> **githubUrl** `string`
>
> GitHub profile URL of the candidate
>
> **websiteUrl** `string`
>
> Personal website URL of the candidate
>
> **linkedInUrl** `string`
>
> LinkedIn profile URL of the candidate
>
> **phoneNumber** `string`
>
> Phone number of the candidate
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Candidate Note
>
> **Slug:** `ASHBY_CREATE_CANDIDATE_NOTE`
>
> Create a note on a candidate profile. Use this to add comments, observations, or feedback about a candidate during the recruitment process.
>
> #### Input Parameters
>
> **note** `string` *required*
>
> The note content. Can be a plain text string or an object with 'value' and 'type' properties. For HTML notes (type='text/html'), supported elements include: \<b>, \<i>, \<u>, \<a>, \<ul>, \<ol>, \<li>, \<code>, \<pre>. Unsupported elements will be stripped.
>
> **candidateId** `string` *required*
>
> The unique identifier of the candidate to add the note to
>
> **sendNotifications** `boolean`
>
> Whether to send notifications about this note to relevant team members. If not specified, follows the default notification settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Candidate Tag
>
> **Slug:** `ASHBY_CREATE_CANDIDATE_TAG`
>
> Create a candidate tag in Ashby for categorizing and organizing candidates. If a tag with the given title already exists, the existing tag is returned.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The title/name of the tag. Must be a non-empty string. Examples: 'Engineering', 'Senior Leadership', 'Remote-First'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Field
>
> **Slug:** `ASHBY_CREATE_CUSTOM_FIELD`
>
> Create a new custom field in Ashby. Custom fields allow you to track additional structured data on Ashby objects like candidates, applications, and jobs. This action creates the field definition that can then be populated with values using the set custom field value actions. Supported field types: - String: Free text input - Number: Numeric values - Boolean: True/false values - Date: Date values (optionally date-only without time) - ValueSelect: Single selection from predefined options - MultiValueSelect: Multiple selections from predefined options - Employee: Reference to an Ashby employee (limited object type support) Note: ValueSelect and MultiValueSelect field types require the selectableValues parameter. Requires the hiringProcessMetadataWrite permission.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The name/title of the custom field
>
> **fieldType** `string` *required*
>
> The type of custom field. Valid values: String, Number, Boolean, Date, ValueSelect, MultiValueSelect, Employee
>
> **objectType** `string` *required*
>
> The type of object this custom field applies to. Common values include: Candidate, Application, Job. Note: Not all field types are supported on all object types.
>
> **description** `string`
>
> Optional description of the custom field
>
> **isDateOnlyField** `boolean`
>
> Whether the field is date-only (no time). Only applicable when fieldType is Date.
>
> **selectableValues** `array`
>
> Array of selectable values with 'label' and 'value' keys. Required for ValueSelect and MultiValueSelect field types. Each item must have 'label' and 'value' keys.
>
> **isExposableToCandidate** `boolean`
>
> Whether the field can be exposed to candidates
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Department
>
> **Slug:** `ASHBY_CREATE_DEPARTMENT`
>
> Create a new department. Use this to add organizational departments or teams for structuring jobs and hierarchy.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the department
>
> **parentId** `string`
>
> The ID of the parent department (for nested departments)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Email Sync Blocked Address
>
> **Slug:** `ASHBY_CREATE_EMAIL_SYNC_BLOCKED_ADDRESS`
>
> Add 1-100 email addresses to the candidate email sync blocklist. The organization must have the blocklist enabled. Blocking applies only to addresses stored on candidate profiles. Matching ignores case but is otherwise exact: [person+tag@example.com](mailto:person+tag@example.com) and [person@example.com](mailto:person@example.com) are separate. Malformed addresses reject the entire batch; already-blocked addresses return their existing entries. Requires organizationWrite permission.
>
> #### Input Parameters
>
> **addresses** `array` *required*
>
> Email addresses to add to the candidate email sync blocklist (1-100). A malformed address rejects the whole batch. Matching ignores case but is otherwise exact; plus-tagged addresses are separate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Interviewer Pause User
>
> **Slug:** `ASHBY_CREATE_INTERVIEWER_PAUSE_USER`
>
> Create an interviewer pause for an Ashby user. While paused, the user will not be scheduled for interviews. Only userId is required: startsAt defaults to the current time, and omitting endsAt makes the pause indefinite. A user may have only one pause at a time, whether active or scheduled; creating another returns an error rather than updating the existing pause. Requires an API key with organizationWrite permission.
>
> #### Input Parameters
>
> **endsAt** `string`
>
> ISO 8601 end date-time with Z or a timezone offset, or null. When omitted, the pause is indefinite.
>
> **userId** `string` *required*
>
> The UUID of the user to pause.
>
> **comment** `string`
>
> Optional reason for the pause, or null.
>
> **startsAt** `string`
>
> ISO 8601 start date-time with Z or a timezone offset, or null. Defaults to the current time when omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Interviewer Pool
>
> **Slug:** `ASHBY_CREATE_INTERVIEWER_POOL`
>
> Create a new interviewer pool. Use this to organize interviewers into groups by expertise or interview type. Requires the hiringProcessMetadataWrite permission.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The title/name of the interviewer pool
>
> **requiresTraining** `boolean`
>
> Indicates whether the pool requires training before members can participate
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Interview Schedule
>
> **Slug:** `ASHBY_CREATE_INTERVIEW_SCHEDULE`
>
> Create a scheduled interview in Ashby for an application. Supply event start and end times and interviewer emails for users in Ashby. Each event may specify an interview UUID; otherwise the organization's default interview is used. Optional event metadata has 100-character key, 512-character value and under-1-KB total limits. Requires interviewsWrite permission.
>
> #### Input Parameters
>
> **applicationId** `string` *required*
>
> The application UUID for this interview schedule.
>
> **interviewEvents** `array` *required*
>
> The list of events that make up this interview schedule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Job
>
> **Slug:** `ASHBY_CREATE_JOB`
>
> Create a new job opening in Ashby ATS. Use this action to: - Add a new role to your organization with a title, department, location, and brand - Set up the job structure before publishing or opening it to candidates - Optionally assign a default interview plan to define the hiring process Important notes: - Newly created jobs start in 'Draft' status and cannot accept applications yet - To open the job for applications, you must set a defaultInterviewPlanId either during creation or update it later - Use LIST\_DEPARTMENTS, LIST\_LOCATIONS, LIST\_BRAND, and LIST\_INTERVIEW\_PLANS actions to get valid IDs - The job creator is automatically set as the author
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The job title (e.g., 'Senior Software Engineer', 'Product Manager')
>
> **teamId** `string` *required*
>
> The department/team ID from LIST\_DEPARTMENTS action. Jobs are organized under departments in the org hierarchy
>
> **brandId** `string` *required*
>
> The brand ID from LIST\_BRAND action. Brand defines employer branding for job postings
>
> **locationId** `string` *required*
>
> The location ID from LIST\_LOCATIONS action where this job is based (office location or remote)
>
> **jobTemplateId** `string`
>
> The job template ID to pre-populate job details. Only active templates are allowed
>
> **defaultInterviewPlanId** `string`
>
> The interview plan ID from LIST\_INTERVIEW\_PLANS action. Required to open/publish the job. Defines the interview process and stages
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Job Posting
>
> **Slug:** `ASHBY_CREATE_JOB_POSTING`
>
> Create a job posting for an existing job. Requires jobsWrite permission. Only jobId is required: title and primary location inherit from the job, status defaults to Draft, isListed defaults to true, and the application form defaults to the organization form. Published postings require a description. The posting always attaches to the external board for the job's brand; board selection and internal-board creation are not supported. isListed=false does not detach it. Confidential jobs force isListed=false. If the job has no default posting, the new posting becomes its default. Repeated calls create new postings.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The UUID of the parent job.
>
> **title** `string`
>
> Posting title; inherits the job title when omitted.
>
> **status** `string ("Draft" | "Published")`
>
> Initial status; defaults to Draft when omitted.
>
> **isListed** `boolean`
>
> List on the external board; defaults to true, but confidential jobs force false.
>
> **locationId** `string`
>
> Primary location UUID; inherits the job location when omitted.
>
> **description** `object`
>
> An HTML description block; required for Published postings.
>
> **workplaceType** `string ("OnSite" | "Hybrid" | "Remote")`
>
> The type of workplace.
>
> **secondaryLocationIds** `array`
>
> Secondary location UUIDs.
>
> **applicationFormDefinitionId** `string`
>
> Application form UUID; uses the organization default when omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Location
>
> **Slug:** `ASHBY_CREATE_LOCATION`
>
> Create a new location or location hierarchy. Use this to add office locations, remote work settings, or nested location structures for organizational management.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the location
>
> **type** `string` *required*
>
> The type of location. Must be 'Location'
>
> **address** `object`
>
> Location address.
>
> **isRemote** `boolean`
>
> Boolean indicating if this is a remote location
>
> **workplaceType** `string ("Hybrid" | "OnSite")`
>
> Workplace type. Valid values: 'Hybrid' or 'OnSite'
>
> **parentLocationId** `string`
>
> ID of parent location for creating hierarchies. Note: parent location must support hierarchy to be used as a parent
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Offer
>
> **Slug:** `ASHBY_CREATE_OFFER`
>
> Create a new offer for a candidate in Ashby ATS. Use this to generate formal job offers with all required field values after starting an offer process and obtaining the form definition. Prerequisites: Must first call offerProcess.start to get offerProcessId, then offer.start to get offerFormId and field definitions. Date fields must use YYYY-MM-DD format (not ISO timestamp).
>
> #### Input Parameters
>
> **offerForm** `object` *required*
>
> The offer form data containing all field submissions. Each field submission includes a path (field UUID) and value based on the field type (date, currency, number, string, boolean, or select).
>
> **offerFormId** `string` *required*
>
> The UUID of the form associated with the offer. This value is the id included in the response of the offer.start API. The form defines which fields need to be filled for the offer.
>
> **offerProcessId** `string` *required*
>
> The UUID of the offer process associated with the offer you're creating. This value is the id included in the response of the offerProcess.start API. Each offer must be associated with an active offer process.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Opening
>
> **Slug:** `ASHBY_CREATE_OPENING`
>
> Create a new opening (job requisition) in Ashby ATS. An opening represents a job requisition - a request to hire for a specific position. All parameters are optional, but typically you'll want to provide at least a title, job IDs, and location IDs for a meaningful opening. Use this action to: - Create a new job opening with specific requirements - Associate openings with existing jobs, locations, and teams - Set hiring targets, employment type, and opening state - Track backfill positions vs new roles Required permission: openingsWrite Note: To get valid IDs for teamId, locationIds, and jobIds, use the corresponding List Departments, List Locations, and List Jobs actions.
>
> #### Input Parameters
>
> **title** `string`
>
> Title of the opening
>
> **jobIds** `array`
>
> Array of job IDs (UUIDs) to associate with the opening. Use List Jobs action to get valid job IDs.
>
> **teamId** `string`
>
> Department/team ID (UUID) to associate with the opening. Use List Departments action to get valid team IDs.
>
> **identifier** `string`
>
> Opening identifier (custom reference code)
>
> **isBackfill** `boolean`
>
> Boolean indicating if this is a backfill position
>
> **description** `string`
>
> Description of the opening
>
> **locationIds** `array`
>
> Array of location IDs (UUIDs) for the opening. Use List Locations action to get valid location IDs.
>
> **openingState** `string`
>
> State of the opening. Valid values: Draft, Open, Closed, Approved, Filled
>
> **employmentType** `string`
>
> Type of employment. Valid values: FullTime, PartTime, Intern, Contract, Temporary
>
> **targetHireDate** `string`
>
> Target date for hiring (ISO 8601 date format)
>
> **targetStartDate** `string`
>
> Target start date for the hire (ISO 8601 date format)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Project
>
> **Slug:** `ASHBY_CREATE_PROJECT`
>
> Create an active project with no candidates; the effective actor becomes its author. Author assignment is not supported. Supply all active required Project custom fields; hidden, inaccessible, or unsupported required fields prevent creation. Custom fields require availability and applicable private/API-only permissions. Confidential projects require Plus, Legacy Plus, or Enterprise availability. Requires projectsWrite. Manage candidate membership using separate endpoints.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The project's title.
>
> **description** `object`
>
> Project description. Omission, null, or empty content leaves it unset.
>
> **confidential** `boolean`
>
> Whether the project is confidential; defaults to false. Requires Plus, Legacy Plus, or Enterprise availability.
>
> **customFields** `array`
>
> Initial values for all required active Project custom fields. Requires Project custom fields availability and applicable private/API-only field permissions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Referral
>
> **Slug:** `ASHBY_CREATE_REFERRAL`
>
> Create a referral in Ashby ATS by submitting a referral form with candidate information. Use this action to formally submit employee referrals for job openings, which creates both a candidate record (if new) and an application linked to the specified job.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The referral form ID. Use the get\_referral\_form action to retrieve the default form ID.
>
> **createdAt** `string`
>
> Optional timestamp for when the referral was created (ISO 8601 format)
>
> **creditedToUserId** `string` *required*
>
> The ID of the user submitting the referral. Use the list\_users action to get valid user IDs.
>
> **fieldSubmissions** `array` *required*
>
> Array of field submissions. Required fields depend on the form definition but typically include: '\_systemfield.job' (job ID from list\_jobs), '\_systemfield\_name' (candidate name), '\_systemfield\_email' (candidate email), and any custom fields from the form definition. Each item has 'path' (the field identifier) and 'value' (the submitted value).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Survey Request
>
> **Slug:** `ASHBY_CREATE_SURVEY_REQUEST`
>
> 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.
>
> #### Input Parameters
>
> **candidateId** `string` *required*
>
> The unique identifier (UUID) for the candidate
>
> **applicationId** `string` *required*
>
> The unique identifier (UUID) for the application
>
> **surveyFormDefinitionId** `string` *required*
>
> The unique identifier (UUID) for the survey form definition to be used
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Survey Submission
>
> **Slug:** `ASHBY_CREATE_SURVEY_SUBMISSION`
>
> 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.
>
> #### Input Parameters
>
> **candidateId** `string` *required*
>
> The UUID of the candidate for whom the survey submission is being created
>
> **applicationId** `string` *required*
>
> The UUID of the application associated with the survey submission
>
> **submittedValues** `object` *required*
>
> An object containing the survey responses as key-value pairs. Keys are field identifiers (e.g., '\_systemfield\_overall\_candexp\_rating') and values are the submitted responses. MultiValueSelect fields accept lists of strings, while single-value fields accept scalar values (str, int, float, bool, or null)
>
> **surveyFormDefinitionId** `string` *required*
>
> The UUID of the survey form definition to use for this submission
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Application
>
> **Slug:** `ASHBY_DELETE_APPLICATION`
>
> Delete an application by ID in Ashby. Requires candidatesDelete permission. This destructive action deletes the application, not the candidate record. Returns the deleted application's ID on success.
>
> #### Input Parameters
>
> **applicationId** `string` *required*
>
> The unique UUID identifier for the application to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Email Sync Blocked Address
>
> **Slug:** `ASHBY_DELETE_EMAIL_SYNC_BLOCKED_ADDRESS`
>
> Remove email addresses from the candidate email sync blocklist. Supply 1-100 addresses exactly as listed; no normalization is performed. Removing an address not on the list succeeds, but that address is omitted from removedAddresses. Removes the blocklist entry, not candidate records or emails. Requires organizationWrite permission.
>
> #### Input Parameters
>
> **addresses** `array` *required*
>
> Email addresses to remove from the candidate email sync blocklist (1-100). Matching is exact; use addresses exactly as listed. Addresses not on the list are ignored.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete User Interviewer Pause
>
> **Slug:** `ASHBY_DELETE_INTERVIEWER_PAUSE_USER`
>
> Delete an interviewer pause by its pause ID and return the deleted ID. Supply interviewerPauseId, not a user ID. This deletes the pause, not the user. Requires an API key with organizationWrite permission.
>
> #### Input Parameters
>
> **interviewerPauseId** `string` *required*
>
> The ID of the interviewer pause to delete, not the user's ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Referral
>
> **Slug:** `ASHBY_DELETE_REFERRAL`
>
> Delete an Ashby referral submission by its ID from referral.list. Requires candidatesDelete permission. The application is not deleted. By default, attribution is unchanged. CreditedToUser removes credited-user attribution while preserving Referral sourcing analytics; Source clears the source; All clears both. Attribution is cleared only if the credited user is still the referral's referrer or the source is still its built-in Referral/Referral Link source, respectively. Response flags report actual changes. Restoring the referral within seven days restores only the referral row, not cleared attribution. referral\_not\_found can mean the referral does not exist or is not visible to the acting user.
>
> #### Input Parameters
>
> **referralId** `string` *required*
>
> The UUID of the referral to delete; use the id returned by referral.list.
>
> **clearAttribution** `string ("None" | "CreditedToUser" | "Source" | "All")`
>
> Attribution to clear when still owned by this referral: None deletes only the referral (default); CreditedToUser clears the credited user while preserving sourcing analytics; Source clears the source; All clears both. Use the string None, not null.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Discard Sequence Draft
>
> **Slug:** `ASHBY_DISCARD_SEQUENCE`
>
> Permanently discard a NotStarted sourcing sequence draft owned by the acting user. Drafts created with x-on-behalf-of require that same acting user for discard. Repeating a successful discard is safe. IDs absent from the acting organization also succeed, without confirming prior existence. Existing but inaccessible, other-user-owned, or non-sourcing sequences return sequence\_not\_found. Started sequences return invalid\_input. Requires sourcingWrite permission.
>
> #### Input Parameters
>
> **sequenceId** `string` *required*
>
> The draft sequence enrollment ID. Must be a NotStarted sourcing sequence owned by the acting user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Report
>
> **Slug:** `ASHBY_GENERATE_REPORT`
>
> Start asynchronous Ashby report generation or poll it once. Start with reportId; poll with reportId and returned requestId every second until complete or failed. No automatic polling or downloads. Repeat resultStyle on every poll; omission defaults to inline. Inline caps uncompressed data at 5 MB; overflow returns failed/ReportTooLargeForInline with URL-shaped data. URL style avoids the cap and requires includeHeadersInData=true or omitted. Single-aggregate Show All reports may fall back to inline: inspect data vs url. Presigned URLs are short-lived; downloads require Brotli decoding. Starts: 15/minute, 3 concurrent builds per organization shared with report.synchronous; slots may outlast HTTP calls. Polls bypass these limits. Inspect results.status/failureReason even when success is true. Suitable for builds exceeding 30 seconds. Requires reportsRead.
>
> #### Input Parameters
>
> **reportId** `string` *required*
>
> The UUID of the report to generate or poll.
>
> **requestId** `string`
>
> Request ID returned by the start call. Supply with reportId to poll; omit to start generation.
>
> **resultStyle** `string ("inline" | "url")`
>
> Inline (default) embeds data with a 5 MB uncompressed cap; url returns a short-lived presigned download URL. Repeat on every poll; the style is not stored server-side.
>
> **includeHeadersInData** `boolean`
>
> Whether the first data row contains column headers (provider default true). URL style requires true or omission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get API Key Info
>
> **Slug:** `ASHBY_GET_API_KEY_INFO`
>
> Retrieve information about the current API key, including its permissions, to check its access level. Requires the apiKeysRead permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Application Info
>
> **Slug:** `ASHBY_GET_APPLICATION_INFO`
>
> Retrieve detailed information about a specific application by its ID. Returns complete details including candidate info, interview stages, and hiring team nested under data.results. To find a recruiting coordinator, match hiringTeam entries where role == "Recruiting Coordinator" (exact string). Optional fields such as primaryEmailAddress may be null; handle accordingly.
>
> #### Input Parameters
>
> **applicationId** `string` *required*
>
> The unique identifier of the application A single candidate may have multiple application IDs; only call for relevant IDs rather than every ID from a bulk list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Candidate Info
>
> **Slug:** `ASHBY_GET_CANDIDATE_INFO`
>
> Retrieve detailed information about a specific candidate by their ID. This action returns comprehensive candidate data including: - Basic information (name, position, company, school) - Contact details (email addresses, phone numbers) - Social profiles (LinkedIn, etc.) - Associated applications and tags - Custom field values - Source and credited user information - Location and timezone - Profile URL Use this when you need complete details about a specific candidate. To find candidate IDs, use the list\_candidates or search\_candidates actions first.
>
> #### Input Parameters
>
> **candidateId** `string` *required*
>
> The unique identifier (UUID) of the candidate to retrieve. Can be obtained from list\_candidates or search\_candidates actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Field Info
>
> **Slug:** `ASHBY_GET_CUSTOM_FIELD_INFO`
>
> 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.
>
> #### Input Parameters
>
> **customFieldId** `string` *required*
>
> The UUID of the custom field to retrieve information about
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Department Info
>
> **Slug:** `ASHBY_GET_DEPARTMENT_INFO`
>
> Retrieve detailed information about a specific department by its ID. Returns comprehensive department details including: - Department name (internal and external) - Parent department relationship (parentId for hierarchical structure) - Archive status (isArchived) - Creation and last update timestamps Use this action when you need information about a specific department (e.g., to verify a department exists, check its archive status, or understand organizational hierarchy). For listing all departments or finding department IDs, use the List Departments action instead. Requires 'organizationRead' permission.
>
> #### Input Parameters
>
> **departmentId** `string` *required*
>
> The unique identifier (UUID) of the department to retrieve. Get valid department IDs using the List Departments action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feedback Form Definition
>
> **Slug:** `ASHBY_GET_FEEDBACK_FORM_DEFINITION`
>
> Retrieve detailed information about a specific feedback form definition by its ID. Use this action to: - Get the complete structure of a feedback form including all sections and fields - View field types (ValueSelect, MultiValueSelect, Boolean, RichText) and their configurations - Check if a form is the default form or a custom scorecard - See which interview the form is linked to (if any) - Access selectable values and field metadata for form rendering To find available feedback form IDs, use the List Feedback Form Definitions action first. Requires the hiringProcessMetadataRead permission.
>
> #### Input Parameters
>
> **feedbackFormDefinitionId** `string` *required*
>
> The unique identifier of the feedback form definition. Use the List Feedback Form Definitions action to discover available form IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get File Info
>
> **Slug:** `ASHBY_GET_FILE_INFO`
>
> Retrieve a pre-signed URL for a file referenced by a public API file handle, such as a candidate file, resume, offer letter, or signature-request file.
>
> #### Input Parameters
>
> **fileHandle** `string` *required*
>
> A file handle string retrieved from the public API. This is typically found in the 'fileHandles' array or 'resumeFileHandle' field in candidate.list or candidate.info responses. The handle is a base64-encoded string containing file metadata and signature.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interviewer Pool Info
>
> **Slug:** `ASHBY_GET_INTERVIEWER_POOL_INFO`
>
> Retrieve detailed information about a specific interviewer pool by its ID. Returns comprehensive pool information including: - Basic details (ID, title, archived status) - Qualified members who can conduct interviews - Trainees currently in training - Training path configuration with stages and requirements Use this to view interviewer pool composition, training programs, and member status for scheduling interviews or managing interviewer assignments.
>
> #### Input Parameters
>
> **interviewerPoolId** `string` *required*
>
> The unique identifier (UUID) of the interviewer pool to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interviewer User Settings
>
> **Slug:** `ASHBY_GET_INTERVIEWER_USER_SETTINGS`
>
> 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.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> The unique identifier of the user to get interviewer settings for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interview Info
>
> **Slug:** `ASHBY_GET_INTERVIEW_INFO`
>
> Retrieve detailed information about a specific interview type by its ID. Use this to get interview details including title, instructions, and feedback form configuration.
>
> #### Input Parameters
>
> **interviewId** `string` *required*
>
> The unique identifier (UUID) of the interview type to retrieve. Use the 'List Interviews' action to get available interview IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Interview Stage Info
>
> **Slug:** `ASHBY_GET_INTERVIEW_STAGE_INFO`
>
> 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.
>
> #### Input Parameters
>
> **interviewStageId** `string` *required*
>
> The unique identifier (UUID) of the interview stage
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Info
>
> **Slug:** `ASHBY_GET_JOB_INFO`
>
> 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. Job offer payloads omit full job details; combine with ASHBY\_LIST\_APPLICATIONS and ASHBY\_GET\_APPLICATION\_INFO for complete reporting data.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The unique identifier of the job
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Interview Plan Info
>
> **Slug:** `ASHBY_GET_JOB_INTERVIEW_PLAN_INFO`
>
> Retrieve the interview plan information for a specific job. Use this to get details about the interview stages and process configured for a job.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The unique identifier of the job to get the interview plan for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Posting Info
>
> **Slug:** `ASHBY_GET_JOB_POSTING_INFO`
>
> Retrieve detailed information about a published job posting by its ID, including description, application form fields, compensation, and listing settings.
>
> #### Input Parameters
>
> **jobPostingId** `string` *required*
>
> The unique identifier of the job posting
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Location Info
>
> **Slug:** `ASHBY_GET_LOCATION_INFO`
>
> Retrieve detailed information about a specific location by its ID. Use this to get complete location details including address, remote status, and workplace type.
>
> #### Input Parameters
>
> **locationId** `string` *required*
>
> The unique identifier of the location
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Offer Info
>
> **Slug:** `ASHBY_GET_OFFER_INFO`
>
> Retrieve detailed information about a specific offer by its ID. This action returns comprehensive offer data including application ID, status, version, timestamps, candidate ID, job ID, start date, and custom fields. Use this when you need complete details about a specific offer. To find offer IDs, use the list\_offers action first. Requires the 'offersRead' permission.
>
> #### Input Parameters
>
> **offerId** `string` *required*
>
> The unique identifier (UUID) of the offer to retrieve. Can be obtained from list\_offers action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Opening Info
>
> **Slug:** `ASHBY_GET_OPENING_INFO`
>
> 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.
>
> #### Input Parameters
>
> **openingId** `string` *required*
>
> The unique identifier (UUID) of the opening to retrieve. Obtain this from the list\_openings action or from job details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Referral Form
>
> **Slug:** `ASHBY_GET_REFERRAL_FORM`
>
> Fetches the default referral form or creates a default referral form if none exists. Requires the hiringProcessMetadataRead permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Survey Form Definition
>
> **Slug:** `ASHBY_GET_SURVEY_FORM_DEFINITION`
>
> Retrieve detailed information about a specific survey form definition by its ID. This action returns comprehensive details about a survey form including: - Survey title and type (e.g., Diversity, EEOC, QualityOfHire) - Form definition with sections and fields - Field types (ValueSelect, MultiValueSelect, RichText, LinearRating, etc.) - Selectable values for choice fields - Required field indicators - Archive status Use the LIST\_SURVEY\_FORM\_DEFINITIONS action first to discover available survey form IDs. Common survey types include candidate experience surveys, hiring manager assessments, quality of hire evaluations, and EEOC compliance forms. Requires the hiringProcessMetadataRead permission.
>
> #### Input Parameters
>
> **surveyFormDefinitionId** `string` *required*
>
> The unique identifier (UUID) of the survey form definition to retrieve. Use the LIST\_SURVEY\_FORM\_DEFINITIONS action to discover available survey form IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Info
>
> **Slug:** `ASHBY_GET_USER_INFO`
>
> Retrieve detailed information about a specific user by their ID. Use this to get user details including name, email, role, and permissions.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> The unique identifier (UUID) of the user to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Info Interview Briefing
>
> **Slug:** `ASHBY_INFO_INTERVIEW_BRIEFING`
>
> Retrieve briefing data for an Ashby interview event. Returns application, interview and stage IDs, per-interviewer feedback and training status, and the feedback form definition ID needed to render a briefing or submit feedback through applicationFeedback.submit. By default, interviewers contain userId and status flags only. Expand interviewers for full user and pool details; other expansions include application, candidate, job, interview and feedback form definition inline. Requires interviewsRead.
>
> #### Input Parameters
>
> **expand** `array`
>
> Related records to include inline. Expand interviewers for full user and pool details; otherwise only userId and status flags are returned.
>
> **interviewEventId** `string` *required*
>
> The UUID of the interview event whose briefing to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Info Notetaker Transcript
>
> **Slug:** `ASHBY_INFO_NOTETAKER_TRANSCRIPT`
>
> Fetch AI Notetaker transcript metadata and a presigned JSON download URL. Requires notetakerRead permission and the organization's AI Notetaker add-on. Discover transcript IDs via interviewEvent.list or interviewSchedule.list. The URL expires after five minutes; call again to refresh it. This action returns the resource URL without downloading the transcript. Free-tier transcripts expire after a retention period; unlimited AI Notetaker avoids that retention expiry. Not-found errors can also mean insufficient access.
>
> #### Input Parameters
>
> **notetakerTranscriptId** `string` *required*
>
> The transcript UUID, discoverable via notetakerTranscriptId on interviewEvent.list or interviewSchedule.list results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Info Project
>
> **Slug:** `ASHBY_INFO_PROJECT`
>
> Retrieve an Ashby project by UUID, including descriptions and custom fields. Requires an API key with either projectsRead or candidatesRead permission.
>
> #### Input Parameters
>
> **projectId** `string` *required*
>
> The UUID of the project to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Info Sequence
>
> **Slug:** `ASHBY_INFO_SEQUENCE`
>
> Retrieve a candidate's sourcing sequence enrollment visible to the acting user. Not-started email stages include resolved, editable subject and HTML body; preserve Ashby token markers when editing. Started sequences return stage metadata without message content. Drafts are visible only to their creator: requests using x-on-behalf-of must continue using the same acting user. Missing, inaccessible and non-sourcing sequences return sequence\_not\_found. Requires sourcingRead permission.
>
> #### Input Parameters
>
> **sequenceId** `string` *required*
>
> The UUID of the candidate's sequence enrollment, not the reusable sequence template ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Info Sequence Template
>
> **Slug:** `ASHBY_INFO_SEQUENCE_TEMPLATE`
>
> Retrieve metadata for a reusable sourcing sequence template visible to the caller. Archived templates may be returned. Message subjects and bodies are not exposed. Returns sequence\_template\_not\_found if the template is missing, is not a reusable sourcing template, or is not visible to the caller. Requires sourcingRead.
>
> #### Input Parameters
>
> **sequenceTemplateId** `string` *required*
>
> The UUID of the reusable sequence template, not a candidate's sequence enrollment ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Take-Home Assignment Info
>
> **Slug:** `ASHBY_INFO_TAKE_HOME_ASSIGNMENT`
>
> Retrieve one take-home assignment, its submission, and assigned reviewers by ID. interviewId links to the interview definition; pass expand=\["interview"] to include it. Missing or invisible assignments return take\_home\_assignment\_not\_found. Resolve submitted file handles separately with file.info. Requires interviewsRead.
>
> #### Input Parameters
>
> **expand** `array`
>
> Use \["interview"] to include the linked interview definition.
>
> **takeHomeAssignmentId** `string` *required*
>
> The take-home assignment ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Application Criteria Evaluations
>
> **Slug:** `ASHBY_LIST_APPLICATION_CRITERIA_EVALUATIONS`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results per page. Default: 100.
>
> **cursor** `string`
>
> Cursor for pagination. Use nextCursor from previous response.
>
> **applicationId** `string` *required*
>
> The unique identifier of the application
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Application Feedback
>
> **Slug:** `ASHBY_LIST_APPLICATION_FEEDBACK`
>
> Retrieve all feedback submissions for an application. Use this to view interviewer feedback, evaluations, and notes collected throughout the hiring process.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results. Use the returned nextCursor value until moreDataAvailable is false.
>
> **syncToken** `string`
>
> Sync token to fetch only feedback that has changed since last sync.
>
> **applicationId** `string` *required*
>
> The unique identifier of the application
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Application Hiring Team Roles
>
> **Slug:** `ASHBY_LIST_APPLICATION_HIRING_TEAM_ROLE`
>
> Retrieve all available hiring team roles for applications in the organization. These roles can be assigned to hiring team members at the application level (e.g., Recruiter, Hiring Manager, Recruiting Coordinator, Sourcer). Use this endpoint to get the complete list of role IDs and titles that are available for assignment. Requires candidatesRead permission. Note: This differs from the general hiring team roles list - this specifically returns roles used at the application level in the hiring workflow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Application History
>
> **Slug:** `ASHBY_LIST_APPLICATION_HISTORY`
>
> Retrieve a paginated history of stage transitions for an application, including when a candidate moved through interview stages. Follow the returned cursor to retrieve subsequent pages.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of history items to return per page. Default and maximum is 100.
>
> **cursor** `string`
>
> Pagination cursor token for retrieving subsequent pages of history entries. Use the nextCursor value from a previous response.
>
> **applicationId** `string` *required*
>
> The unique identifier (UUID) of the application to retrieve history for. Obtain this from list\_applications or create\_application actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Applications
>
> **Slug:** `ASHBY_LIST_APPLICATIONS`
>
> Retrieve a list of applications with optional pagination and sync-token filtering for incremental updates. No server-side recruiter filter exists; attribute applications to team members client-side.
>
> #### Input Parameters
>
> **jobId** `string`
>
> Filter applications by job UUID.
>
> **limit** `integer`
>
> Maximum number of items to return per page (1-100). Defaults to 100 if not specified.
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results. Loop until `nextCursor` is null or `moreDataAvailable` is false to avoid missing records; each page returns up to \~100 results.
>
> **expand** `array`
>
> List of related object fields to expand and include in the response.
>
> **status** `string`
>
> Filter applications by status. Allowed values: Hired, Archived, Active, Lead.
>
> **syncToken** `string`
>
> Sync token to fetch only applications that have changed since last sync.
>
> **createdAfter** `integer`
>
> Unix timestamp in milliseconds. Only returns applications created after this date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Approvals
>
> **Slug:** `ASHBY_LIST_APPROVAL`
>
> Retrieve a list of approvals (offer approvals, job approvals, etc.). Use this to track approval workflows and pending approvals.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only approvals that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Archive Reasons
>
> **Slug:** `ASHBY_LIST_ARCHIVE_REASONS`
>
> Retrieve a list of all archive reasons. Use this to see available reasons for archiving candidates or applications, such as rejection categories.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Brands
>
> **Slug:** `ASHBY_LIST_BRAND`
>
> Retrieve a list of all brands for the organization. Use this to get available brands for job postings and employer branding. Requires organizationRead permission.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results per page. Default: 100.
>
> **cursor** `string`
>
> Cursor for pagination. Use nextCursor from previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Candidate Client Info
>
> **Slug:** `ASHBY_LIST_CANDIDATE_CLIENT_INFO`
>
> Retrieve all client info records for a specific candidate with pagination support. Client info records contain additional client-specific information associated with candidates in your Ashby account. This endpoint supports pagination and incremental synchronization for efficient data retrieval. Use the cursor and limit parameters to paginate through large result sets. For incremental syncing, use the syncToken to fetch only changes since your last sync. Requires candidatesRead permission.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of records to return per request. Default and maximum is 100
>
> **cursor** `string`
>
> Opaque cursor for fetching the next page of results. Use the nextCursor from the previous response
>
> **syncToken** `string`
>
> Token representing the last successful sync for incremental synchronization. Use this to fetch only changes since last sync
>
> **candidateId** `string` *required*
>
> The unique identifier (UUID) of the candidate to retrieve client info for
>
> **createdAfter** `integer`
>
> Timestamp in milliseconds since Unix epoch. Only return records created after this time
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Candidate Notes
>
> **Slug:** `ASHBY_LIST_CANDIDATE_NOTES`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of notes to return per page. If not specified, the API will use its default limit.
>
> **cursor** `string`
>
> Pagination cursor for fetching the next page of results. Use the nextCursor value from a previous response to get more notes.
>
> **syncToken** `string`
>
> Sync token for incremental updates. Use this to fetch only notes that have changed since your last sync.
>
> **candidateId** `string` *required*
>
> The unique identifier (UUID) of the candidate whose notes you want to retrieve. Get this ID from list\_candidates or search\_candidates actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Candidate Projects
>
> **Slug:** `ASHBY_LIST_CANDIDATE_PROJECTS`
>
> Retrieve all projects associated with a candidate. Use this to see which sourcing projects or recruiting initiatives a candidate is part of.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results per page. Default: 100.
>
> **cursor** `string`
>
> Cursor for pagination. Use nextCursor from previous response.
>
> **candidateId** `string` *required*
>
> The unique identifier (UUID) of the candidate whose project associations to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Candidates
>
> **Slug:** `ASHBY_LIST_CANDIDATES`
>
> Retrieve a list of candidates. Use this to fetch all candidates with optional pagination and filtering by sync token for incremental updates.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results Loop using the returned `nextCursor` value until it is null or `moreDataAvailable` is false to avoid missing records.
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only candidates that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Candidate Tags
>
> **Slug:** `ASHBY_LIST_CANDIDATE_TAGS`
>
> 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.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results
>
> **perPage** `integer`
>
> Number of results to return per page (1-100)
>
> **syncToken** `string`
>
> Sync token to fetch only tags that have changed since last sync. Use the syncToken from a previous response to get incremental updates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Close Reasons
>
> **Slug:** `ASHBY_LIST_CLOSE_REASONS`
>
> Lists all close reasons for jobs or openings. Close reasons categorize why a job or opening was closed (e.g., rejected by candidate, rejected by organization, or other reasons). Requires hiringProcessMetadataRead permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Communication Templates
>
> **Slug:** `ASHBY_LIST_COMMUNICATION_TEMPLATES`
>
> List enabled communication templates, including available email and message templates for candidate outreach. Requires hiringProcessMetadataRead permission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Fields
>
> **Slug:** `ASHBY_LIST_CUSTOM_FIELDS`
>
> Retrieve a page of custom field definitions in Ashby, including field types and selectable values where available. Use it to discover fields for candidates, applications, jobs, offers, and openings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Departments
>
> **Slug:** `ASHBY_LIST_DEPARTMENTS`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of departments to return per page. Must be between 1 and 100. Defaults to API maximum if not specified.
>
> **cursor** `string`
>
> Pagination cursor from a previous response's nextCursor field. Omit for the first page of results.
>
> **syncToken** `string`
>
> Token from a previous sync to fetch only departments updated since then. Use for incremental synchronization workflows.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Email Sender
>
> **Slug:** `ASHBY_LIST_EMAIL_SENDER`
>
> List email addresses available to the acting identity for sending through Ashby. Includes primary addresses, personal aliases, organization aliases and no-reply addresses across brands. Sending endpoints may accept only a subset; sequence.add always rejects NoReply senders. Without X-On-Behalf-Of, the acting identity is the API service user, generally with organization-wide and no-reply addresses. Use authorized X-On-Behalf-Of connection headers to discover a user's personal addresses. Requires sourcingRead permission. No request parameters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Email Sync Blocked Address
>
> **Slug:** `ASHBY_LIST_EMAIL_SYNC_BLOCKED_ADDRESS`
>
> List one page of addresses on the candidate email-sync blocklist, oldest first. Use cursor=start for the first page, then pass nextCursor unchanged to retrieve subsequent pages when moreDataAvailable is true. The maximum page size is 100. Returns pagination metadata and the final-page syncToken when provided by Ashby; this endpoint's documented request supports cursor and limit only, not a sync token input. Requires an API key with organizationRead permission.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum blocked addresses per page, from 1 to 100, or null for the provider default.
>
> **cursor** `string`
>
> Pagination cursor, or null. Use start for the first page or nextCursor from the previous response; pass cursors unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Feedback Form Definitions
>
> **Slug:** `ASHBY_LIST_FEEDBACK_FORM_DEFINITIONS`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results per page. Default: 100.
>
> **cursor** `string`
>
> Cursor for pagination. Use nextCursor from previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Candidate Fraud Checks
>
> **Slug:** `ASHBY_LIST_FRAUD_CHECKS_CANDIDATE`
>
> List one page of fraud checks performed on a candidate in Ashby. Returns checks and their detected fraud signals. Pass nextCursor as cursor to retrieve subsequent pages. Signal categories, names, descriptions, and values are unstable and may change. Requires candidatesRead permission.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum number of items to return. The provider default and maximum is 100.
>
> **cursor** `string`
>
> Opaque cursor indicating which page to fetch; use nextCursor from the previous response.
>
> **candidateId** `string` *required*
>
> The UUID of the candidate to fetch fraud checks for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Hiring Team Roles
>
> **Slug:** `ASHBY_LIST_HIRING_TEAM_ROLE`
>
> 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.
>
> #### Input Parameters
>
> **namesOnly** `boolean`
>
> If true (default), returns an array of role titles. If false, returns an array of objects with each role's id and title.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List User Interviewer Pauses
>
> **Slug:** `ASHBY_LIST_INTERVIEWER_PAUSES_USER`
>
> List all active or scheduled interviewer pauses for an Ashby user. Requires organizationRead permission. When called with X-On-Behalf-Of, the acting user must have permission to administer users unless requesting their own data. A null endsAt indicates an indefinite pause. Returns the complete list without pagination; does not create or change pauses.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> The UUID of the user to list interviewer pauses for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interviewer Pools
>
> **Slug:** `ASHBY_LIST_INTERVIEWER_POOLS`
>
> 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.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only interviewer pools that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interview Events
>
> **Slug:** `ASHBY_LIST_INTERVIEW_EVENTS`
>
> Retrieves all interview events for a specific interview schedule. Each interview event represents a scheduled time slot with assigned interviewers for conducting interviews. Use this action to: - Get details about scheduled interviews including start/end times, locations, and meeting links - View which interviewers are assigned to each interview event - Check feedback submission status for interviews - Access feedback submission links for interviewers Key information returned: - Event timing (start/end times in ISO 8601 format) - Interviewer details (names, emails, roles) - Meeting logistics (physical location or virtual meeting link) - Feedback status and submission links Supports pagination via cursor and incremental synchronization via syncToken. Requires interviewsRead permission.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Optional. Maximum number of interview events to return per page (1-100). Defaults to API's default page size if not specified.
>
> **cursor** `string`
>
> Optional. Pagination cursor from a previous response's nextCursor field. Use this to fetch subsequent pages of results when moreDataAvailable is true.
>
> **syncToken** `string`
>
> Optional. Sync token from a previous response. When provided, returns only events that have been created or updated since that token was issued. Useful for incremental data synchronization.
>
> **interviewScheduleId** `string` *required*
>
> Required. The unique identifier (UUID) of the interview schedule to retrieve events for. Obtain this from LIST\_INTERVIEW\_SCHEDULES action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interview Plans
>
> **Slug:** `ASHBY_LIST_INTERVIEW_PLANS`
>
> List published interview plans, with an option to include archived plans. Draft interview plans are not returned.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only interview plans that have changed since last sync
>
> **includeArchived** `boolean`
>
> Whether to include archived interview plans in the results
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interview Types
>
> **Slug:** `ASHBY_LIST_INTERVIEWS`
>
> 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.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor from a previous response's nextCursor field. Use this to fetch subsequent pages of results.
>
> **perPage** `integer`
>
> Number of interview records to return per page. Defaults to server default if not specified.
>
> **syncToken** `string`
>
> Sync token from a previous response. When provided, only returns interviews that have been created or updated since the token was issued. Useful for incremental syncing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interview Schedules
>
> **Slug:** `ASHBY_LIST_INTERVIEW_SCHEDULES`
>
> Retrieve a list of interview schedules. Use this to fetch all scheduled interviews with candidates, including timing, interviewers, and interview details.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only interview schedules that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interview Stage Groups
>
> **Slug:** `ASHBY_LIST_INTERVIEW_STAGE_GROUPS`
>
> Retrieve a list of interview stage groups. Use this to see how interview stages are organized into logical groups within interview plans.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interview Stages
>
> **Slug:** `ASHBY_LIST_INTERVIEW_STAGES`
>
> 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.
>
> #### Input Parameters
>
> **interviewPlanId** `string` *required*
>
> UUID of the interview plan to list stages for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Boards
>
> **Slug:** `ASHBY_LIST_JOB_BOARDS`
>
> Retrieve a list of enabled job boards where job postings can be published.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Postings
>
> **Slug:** `ASHBY_LIST_JOB_POSTINGS`
>
> List job postings with optional pagination and incremental sync. Published postings are returned by default; unpublished drafts can also be included.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results Check the moreDataAvailable flag in each response; if true, pass the returned cursor into the next call. Stopping early silently omits remaining job postings.
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only job postings that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Jobs
>
> **Slug:** `ASHBY_LIST_JOBS`
>
> 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. When ASHBY\_LIST\_JOB\_POSTINGS returns zero results, use this action as the authoritative source for open job data. Job payloads exclude application details; follow up with ASHBY\_LIST\_APPLICATIONS or ASHBY\_GET\_APPLICATION\_INFO for complete data.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only jobs that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Templates
>
> **Slug:** `ASHBY_LIST_JOB_TEMPLATES`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of job templates to return per page. Default and maximum is 100.
>
> **cursor** `string`
>
> Opaque cursor for pagination. Pass the 'nextCursor' value from a previous response to fetch the next page of results.
>
> **syncToken** `string`
>
> Token for incremental sync. Pass a syncToken from a previous response to only fetch job templates that have changed since then.
>
> **createdAfter** `integer`
>
> Unix epoch timestamp in milliseconds. Only return job templates created after this time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Locations
>
> **Slug:** `ASHBY_LIST_LOCATIONS`
>
> List locations and their office and remote work settings. Results are paginated; regions are not returned.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results per page. Default: 100.
>
> **cursor** `string`
>
> Cursor for pagination. Use nextCursor from previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Offers
>
> **Slug:** `ASHBY_LIST_OFFERS`
>
> Retrieve a list of job offers with their latest versions. This action fetches all offers made to candidates in your Ashby account. Use pagination (cursor/perPage) to handle large result sets efficiently. Use syncToken for incremental updates to fetch only changed offers since last sync. Use createdAfter to filter offers by creation time. Requires the 'offersRead' permission.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Pagination cursor to fetch the next page of results. Use the nextCursor value from a previous response. Stop paginating when moreDataAvailable is false or nextCursor is null.
>
> **perPage** `integer`
>
> Number of offers to return per page (1-100). Defaults to 100 if not specified.
>
> **syncToken** `string`
>
> Sync token for incremental updates. Fetches only offers that changed since the last sync. Use the syncToken from a previous response.
>
> **createdAfter** `integer`
>
> Unix timestamp in milliseconds. Returns only offers created after this time. Filters on offer creation time; response also includes decidedAt for decision timestamps.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Openings
>
> **Slug:** `ASHBY_LIST_OPENINGS`
>
> Retrieve a list of openings (job requisitions). Use this to fetch all openings with optional pagination and filtering. Each opening may represent multiple hires; inspect headcount fields rather than assuming one opening equals one hire.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results Check the `moreDataAvailable` flag in each response; if true, pass the returned `cursor` into the next call to retrieve additional pages.
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only openings that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Projects
>
> **Slug:** `ASHBY_LIST_PROJECTS`
>
> Retrieve a list of all projects. Use this to see candidate sourcing projects and recruiting initiatives.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only projects that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Referrals
>
> **Slug:** `ASHBY_LIST_REFERRAL`
>
> List one page of referral submissions visible to the acting user. Optionally filter by application or creation time, or supply a sync token for incremental updates. Continue with nextCursor while moreDataAvailable is true; save the last page's syncToken for future syncs. Beta includeVisibilityConditions returns conditional form rules when available. Requires candidatesRead permission.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum items per page. Ashby's default and maximum is 100.
>
> **cursor** `string`
>
> Pagination cursor. Use start for the first page or nextCursor from the previous response.
>
> **syncToken** `string`
>
> Token from a previous completed list to retrieve referrals updated since that sync.
>
> **createdAfter** `number`
>
> Unix timestamp in milliseconds; return referrals created at or after this time.
>
> **applicationId** `string`
>
> Application ID to filter referrals by, or null.
>
> **includeVisibilityConditions** `boolean`
>
> Beta: include each form field's visibilityCondition tree. Defaults to false; may not be available for all organizations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sequence
>
> **Slug:** `ASHBY_LIST_SEQUENCE`
>
> List one page of visible sourcing enrollments across the organization or for a candidate. Lists Running, Paused, Completed, Cancelled and Unsubscribed sequences, not NotStarted drafts. Delayed enrollments appear as Running. Pass nextCursor unchanged to continue paging; use the final-page syncToken for a future incremental sync. Perform a new full sync after changing the acting identity or its visibility. Author-profile-only changes do not cause unchanged enrollments to be returned again. Requires sourcingRead permission.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum enrollments per page, from 1 to 100. Defaults to 100 when omitted.
>
> **cursor** `string`
>
> Opaque nextCursor from the previous page; pass unchanged.
>
> **syncToken** `string`
>
> Sync token for enrollments updated since the last sync; pass unchanged.
>
> **candidateId** `string`
>
> Only return enrollments for this candidate UUID; omit to list across the organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sequence Template
>
> **Slug:** `ASHBY_LIST_SEQUENCE_TEMPLATE`
>
> List one page of reusable sourcing sequence templates visible to the caller. Returns template and cadence metadata only, not message subjects or bodies. Archived templates are excluded by default; set includeArchived=true when maintaining a complete synchronized catalog. Pass nextCursor unchanged to continue paging and use the final-page syncToken for a future incremental sync. Page size defaults to 100 and cannot exceed 100. Requires sourcingRead.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum templates per page, from 1 to 100. Defaults to 100 when omitted.
>
> **cursor** `string`
>
> Opaque nextCursor from the previous page; pass unchanged.
>
> **syncToken** `string`
>
> Opaque token from the final page of the last completed sync, for the next incremental sync.
>
> **includeArchived** `boolean`
>
> Include archived templates. Defaults to false; use true to maintain a complete synchronized catalog.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sources
>
> **Slug:** `ASHBY_LIST_SOURCES`
>
> 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).
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results. Use the returned nextCursor value until moreDataAvailable is false.
>
> **syncToken** `string`
>
> Sync token to fetch only sources that have changed since last sync.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Source Tracking Links
>
> **Slug:** `ASHBY_LIST_SOURCE_TRACKING_LINKS`
>
> List Ashby source tracking links, including their tracking codes, URLs, enabled status, and source IDs. Supports cursor pagination and incremental synchronization; additional pages may be needed to retrieve all links.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results. Use the returned nextCursor value until moreDataAvailable is false.
>
> **syncToken** `string`
>
> Sync token to fetch only tracking links that have changed since last sync.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Survey Form Definitions
>
> **Slug:** `ASHBY_LIST_SURVEY_FORM_DEFINITIONS`
>
> 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.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results per page. Default: 100.
>
> **cursor** `string`
>
> Cursor for pagination. Use nextCursor from previous response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Survey Requests
>
> **Slug:** `ASHBY_LIST_SURVEY_REQUEST`
>
> List one page of existing Ashby survey requests of the required survey type. Requires candidatesRead permission. Supports CandidateExperience or Questionnaire surveys, optional application/candidate filters, and a created-at-or-after filter in Unix milliseconds. Pass nextCursor as cursor for later pages; store the final syncToken for incremental syncs. Returns candidate survey URLs without visiting them. Does not create requests, submit responses, or email candidates.
>
> #### Input Parameters
>
> **limit** `number`
>
> Maximum items to return. Provider default and maximum is 100.
>
> **cursor** `string`
>
> Pagination cursor: use start for the first page or nextCursor from a previous response.
>
> **syncToken** `string`
>
> Opaque token from the previous completed sync to retrieve requests updated since then.
>
> **surveyType** `string ("CandidateExperience" | "Questionnaire")` *required*
>
> Return only survey requests of this type.
>
> **candidateId** `string`
>
> Filter to requests for this candidate UUID.
>
> **createdAfter** `number`
>
> Return requests created at or after this Unix timestamp in milliseconds.
>
> **applicationId** `string`
>
> Filter to requests for this application UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Survey Submissions
>
> **Slug:** `ASHBY_LIST_SURVEY_SUBMISSIONS`
>
> Lists all survey submissions of a given survey type from Ashby. Survey submissions contain candidate responses to surveys sent during the hiring process. Use this action to: - Retrieve candidate experience survey responses - Access submitted survey data including answers and metadata - Paginate through large sets of submissions using cursor - Sync only new/updated submissions using syncToken - Filter submissions by creation date using createdAfter The most common survey type is 'CandidateExperience'. This action returns empty results if no submissions exist for the specified type. Requires candidatesRead permission.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return (1-100)
>
> **cursor** `string`
>
> Pagination cursor for fetching the next page of results
>
> **syncToken** `string`
>
> Token for data synchronization to fetch only submissions that have changed since last sync
>
> **surveyType** `string` *required*
>
> The type of survey submissions to fetch. Use 'CandidateExperience' for candidate experience surveys. Note: The valid survey types for this endpoint may differ from the surveyType field returned by surveyFormDefinition.list.
>
> **createdAfter** `integer`
>
> Unix timestamp in milliseconds to filter submissions created after this date
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Take Home Assignments
>
> **Slug:** `ASHBY_LIST_TAKE_HOME_ASSIGNMENT`
>
> List one page of take-home assignments visible to the caller. Requires interviewsRead permission. Includes candidate submission metadata and reviewer feedback status. Optionally filter by application or candidate and expand \['interview'] for the linked definition. Pass nextCursor as cursor to continue; retain the final syncToken for incremental syncs. Returned file handles can be resolved separately with file.info; this action does not download files.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum items per page. Provider default and documented maximum is 100.
>
> **cursor** `string`
>
> Opaque nextCursor from the previous page.
>
> **expand** `array`
>
> Pass \['interview'] to include related interview definitions.
>
> **syncToken** `string`
>
> Opaque token from the last page of a successful sync for incremental synchronization.
>
> **candidateId** `string`
>
> Filter to assignments for this candidate UUID.
>
> **applicationId** `string`
>
> Filter to assignments for this application UUID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `ASHBY_LIST_USERS`
>
> Retrieve a paginated list of users in the organization, including team member details and roles. By default, only active users are returned; deactivated users can be included.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor for pagination to fetch the next set of results. Loop using the returned `nextCursor` value until it is null or `moreDataAvailable` is false to avoid missing records.
>
> **perPage** `integer`
>
> Number of results to return per page
>
> **syncToken** `string`
>
> Sync token to fetch only users that have changed since last sync
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Version
>
> **Slug:** `ASHBY_LIST_VERSION`
>
> List available Ashby API versions and their lifecycle statuses. Callable by any credential; no permission is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Move Department
>
> **Slug:** `ASHBY_MOVE_DEPARTMENT`
>
> 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.
>
> #### Input Parameters
>
> **parentId** `string`
>
> UUID of the new parent department. Set to null to make it a top-level department with no parent
>
> **departmentId** `string` *required*
>
> UUID of the department to be moved
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Move Location
>
> **Slug:** `ASHBY_MOVE_LOCATION`
>
> Tool to move a location to a different parent in the location hierarchy. Use when reorganizing location structure or changing parent-child relationships. Requires the organizationWrite permission.
>
> #### Input Parameters
>
> **locationId** `string` *required*
>
> UUID of the location to be moved
>
> **parentLocationHierarchyId** `string` *required*
>
> UUID of the parent location hierarchy where the location will be moved. Must be a LocationHierarchy type, not a Location type
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reject Offer Approval
>
> **Slug:** `ASHBY_REJECT_OFFER`
>
> Reject the current offer approval step, rejecting the approval process and cancelling the offer. Obtain the offer version entityId, current step, and an eligible approver from approval.list. This does not record a candidate declining an extended offer; use offer.setStatus for that. Requires offersWrite permission.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> ID of a user who is an approver for the current step.
>
> **comment** `string`
>
> Optional comment to record with the rejection.
>
> **approvalStepId** `string` *required*
>
> Current approval step ID from approval.list.
>
> **offerVersionId** `string` *required*
>
> Offer version to reject; obtain as entityId from approval.list.
>
> **excludeFormDefinition** `boolean`
>
> If true, omit the offer form definition from the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Hiring Team Member
>
> **Slug:** `ASHBY_REMOVE_HIRING_TEAM_MEMBER`
>
> Remove an Ashby user from a hiring team role at the application, job, or opening level. Requires the organizationWrite permission.
>
> #### Input Parameters
>
> **jobId** `string`
>
> ID of the job to remove team member from. Either applicationId, jobId, or openingId must be provided, but not multiple.
>
> **roleId** `string` *required*
>
> ID of the hiring team role from which to remove the user. This must be a valid UUID from your organization's hiring team roles.
>
> **openingId** `string`
>
> ID of the opening to remove team member from. Either applicationId, jobId, or openingId must be provided, but not multiple.
>
> **teamMemberId** `string` *required*
>
> ID of the Ashby user to remove from the hiring team.
>
> **applicationId** `string`
>
> ID of the application to remove team member from. Either applicationId, jobId, or openingId must be provided, but not multiple.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Application Hiring Team Member
>
> **Slug:** `ASHBY_REMOVE_HIRING_TEAM_MEMBER_APPLICATION`
>
> Unassign a hiring team role from an Ashby user on a specific application. Requires application, team member, and hiring team role IDs and an API key with candidatesWrite permission. Does not delete the user or application. Returns the remaining hiring team members, or an empty list when none remain.
>
> #### Input Parameters
>
> **roleId** `string` *required*
>
> The ID of the hiring team role to unassign.
>
> **teamMemberId** `string` *required*
>
> The ID of the user to unassign the role from.
>
> **applicationId** `string` *required*
>
> The application to unassign the user's role from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove User from Interviewer Pool
>
> **Slug:** `ASHBY_REMOVE_INTERVIEWER_POOL_USER`
>
> Remove a user from an interviewer pool. Use this to unassign interviewers from specific interview pools when they should no longer be part of that pool's roster. This removes the user from either the qualified members list or trainees list, depending on their current status in the pool. Requires the hiringProcessMetadataWrite permission.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> UUID of the user to remove from the interviewer pool
>
> **interviewerPoolId** `string` *required*
>
> UUID of the interviewer pool from which to remove the user
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Opening Job
>
> **Slug:** `ASHBY_REMOVE_OPENING_JOB`
>
> Remove a job from an opening (job requisition) in Ashby ATS. Use this action to disassociate a job from a specific opening. This is useful when: - A job was added to the wrong opening - You need to reorganize job-opening associations - An opening should no longer be associated with a particular job The action removes the job from the opening's jobIds list and returns the updated opening object. Both the opening and job must exist and be valid. Requires jobsWrite permission.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The unique identifier of the job to be removed from the opening
>
> **openingId** `string` *required*
>
> The unique identifier of the opening from which to remove the job
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Opening Location
>
> **Slug:** `ASHBY_REMOVE_OPENING_LOCATION`
>
> 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.
>
> #### Input Parameters
>
> **openingId** `string` *required*
>
> The UUID of the opening to remove the location from
>
> **locationId** `string` *required*
>
> The UUID of the location to be removed from the opening
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Candidate from Project
>
> **Slug:** `ASHBY_REMOVE_PROJECT_CANDIDATE`
>
> Remove a candidate from a project in Ashby. Supply the candidateId and projectId of the membership to remove. This removes the association, not the candidate or project. Returns the updated candidate. Requires candidatesWrite permission.
>
> #### Input Parameters
>
> **projectId** `string` *required*
>
> The UUID of the project to remove the candidate from.
>
> **candidateId** `string` *required*
>
> The UUID of the candidate to remove from the project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Tag Candidate
>
> **Slug:** `ASHBY_REMOVE_TAG_CANDIDATE`
>
> Remove a tag from an Ashby candidate using the candidate and tag UUIDs. Returns the updated candidate. This removes the association only, not the tag definition. Requires an API key with candidatesWrite permission.
>
> #### Input Parameters
>
> **tagId** `string` *required*
>
> The UUID of the tag to remove from this candidate.
>
> **candidateId** `string` *required*
>
> The UUID of the candidate to remove the tag from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Restore Department
>
> **Slug:** `ASHBY_RESTORE_DEPARTMENT`
>
> Restore an archived department by its unique identifier. Restoring a department marks it as active again, making it available in active department lists and allowing it to be used for new jobs and organizational structures. All historical data and relationships are preserved. This action is idempotent - restoring an already active department will succeed and return the same result. Use cases: - Reactivate a previously archived department that is needed again - Undo an accidental archive operation - Restore departments as part of organizational restructuring Required permission: organizationWrite
>
> #### Input Parameters
>
> **departmentId** `string` *required*
>
> The unique identifier of the archived department to restore
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Restore Interviewer Pool
>
> **Slug:** `ASHBY_RESTORE_INTERVIEWER_POOL`
>
> Restore an archived interviewer pool in Ashby. This unarchives the pool, making it available again for new interview assignments. Use this when you need to reactivate an interviewer pool that was previously archived (e.g., reviving a pool for a role that's hiring again or correcting an accidental archive). The operation is idempotent - restoring an already active pool will succeed without errors. Requires the hiringProcessMetadataWrite permission. To archive a pool, use the ASHBY\_ARCHIVE\_INTERVIEWER\_POOL action.
>
> #### Input Parameters
>
> **interviewerPoolId** `string` *required*
>
> The unique identifier (UUID) of the interviewer pool to restore. You can get this ID from LIST\_INTERVIEWER\_POOLS or GET\_INTERVIEWER\_POOL\_INFO actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Restore Location
>
> **Slug:** `ASHBY_RESTORE_LOCATION`
>
> Restores an archived location or location hierarchy in Ashby. When restored, the location is marked as active (isArchived=false) and becomes available again for job postings, assignments, and other location-based operations. The operation is idempotent - restoring an already active location succeeds without error. Requires the organizationWrite permission. Common use cases: - Reactivating previously closed office locations - Undoing accidental location archives - Bringing back seasonal or temporary office locations - Restoring location availability during organizational restructuring Note: Use archive\_location to archive a location if needed.
>
> #### Input Parameters
>
> **locationId** `string` *required*
>
> The UUID of the archived location to restore
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Restore Project
>
> **Slug:** `ASHBY_RESTORE_PROJECT`
>
> Restore an archived Ashby project, returning the project record. Calling this on an already active project also succeeds. Candidate memberships, history, authorship, confidentiality, descriptions, and custom-field values are preserved. Does not permanently delete projects or candidates. Requires projectsWrite permission and an effective actor allowed to edit the project, including for authorized on-behalf-of requests.
>
> #### Input Parameters
>
> **projectId** `string` *required*
>
> The UUID of the project to restore.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Candidates
>
> **Slug:** `ASHBY_SEARCH_CANDIDATES`
>
> 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.
>
> #### Input Parameters
>
> **name** `string`
>
> Name to search for (partial match)
>
> **email** `string`
>
> Email address to search for (exact match)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Jobs
>
> **Slug:** `ASHBY_SEARCH_JOBS`
>
> 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.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Job title to search for (required). Performs a partial match search - e.g., 'engineer' will match 'Backend Engineer', 'Frontend Engineer', etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Opening
>
> **Slug:** `ASHBY_SEARCH_OPENING`
>
> Search for openings by identifier. Use this for quick lookups to find specific openings without pagination. Returns empty results if no match found.
>
> #### Input Parameters
>
> **identifier** `string` *required*
>
> The opening identifier to search for (e.g., '1', '2', '3'). Returns empty results array if no match found.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Projects
>
> **Slug:** `ASHBY_SEARCH_PROJECTS`
>
> Search for projects by title in Ashby. Projects in Ashby are used to track sourcing initiatives, recruiting campaigns, or candidate portfolios. Use this action to: - Quickly find projects by title without pagination - Perform partial match searches (e.g., "recruiting" matches "Engineering Recruiting 2024") - Look up specific sourcing projects or initiatives by name - Build project autocomplete features Returns matching projects with details including id, title, archive status, confidentiality settings, author, and creation timestamp. Note: Results are limited to 100 matches. If you need to browse all projects or expect more results, use the List Projects action instead for paginated access.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Project title to search for (required). Performs a partial match search - e.g., 'recruiting' will match 'Engineering Recruiting 2024', 'Sales Recruiting', etc. Use keywords from the project name you're looking for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Candidate Suggestions
>
> **Slug:** `ASHBY_SEARCH_SUGGESTIONS_CANDIDATE`
>
> Search candidates by email and/or name for typeahead suggestions. Returns only candidate ID, name, and primary email, not full candidate records. Requires an API key with the candidatesRead permission.
>
> #### Input Parameters
>
> **name** `string`
>
> The candidate's name to search for.
>
> **email** `string`
>
> The candidate's email address to search for.
>
> **limit** `integer`
>
> Maximum suggestions to return; Ashby defaults to 10 (maximum 100).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Users
>
> **Slug:** `ASHBY_SEARCH_USERS`
>
> 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.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address of the user to search for. Must be a valid email format. The API performs case-insensitive exact matching on the email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Custom Field Value
>
> **Slug:** `ASHBY_SET_CUSTOM_FIELD_VALUE`
>
> 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.
>
> #### Input Parameters
>
> **fieldId** `string` *required*
>
> The ID of the custom field to set. Use the List Custom Fields action to get available field IDs
>
> **objectId** `string` *required*
>
> The ID of the object to update (e.g., candidate ID, application ID, job ID)
>
> **fieldValue** `string` *required*
>
> The value to set. Type depends on the field: Boolean for boolean fields, ISO date string for Date fields, string for text fields (String, Email, Phone, LongText), number for Number fields, array of strings for MultiValueSelect, NumberRangeValue object for NumberRange, CompensationRangeValue object for CompensationRange
>
> **objectType** `string` *required*
>
> The type of object being updated. Valid values: Candidate, Application, Job, Offer, Opening, CandidateAvailability, InterviewSchedule, Location, User
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Project Custom Field Value
>
> **Slug:** `ASHBY_SET_CUSTOM_FIELD_VALUE_PROJECT`
>
> Update or clear one project custom field, including on archived projects. Unrelated fields and project properties remain unchanged. Requires projectsWrite, project edit permission, Project custom fields availability, and applicable private and API-only field permissions. Delegated humans cannot change or clear API-only values. New User references must be active nonservice users in the organization visible to the effective actor. Historical references must remain in the organization and visible. Avoid concurrent updates: last completed write wins, and retries can overwrite newer values. Discover definitions and users using separate endpoints.
>
> #### Input Parameters
>
> **fieldId** `string`
>
> An active Project custom field ID; supply this or referenceIdentifier.
>
> **projectId** `string` *required*
>
> The project to edit, including archived projects.
>
> **fieldValue** `string` *required*
>
> Canonical value: text, boolean, finite number, configured option values, ISO date/timestamp, or eligible User UUID. Null clears an optional field, including when already empty; required fields cannot be cleared. Multi-select inputs replace all selections.
>
> **referenceIdentifier** `string`
>
> Beta field reference ID, exactly as saved; supply this or fieldId.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Custom Field Values
>
> **Slug:** `ASHBY_SET_CUSTOM_FIELD_VALUES`
>
> Set the values of multiple custom fields for a given object in a single call. Use when you need to update multiple custom fields on the same object (candidate, application, job, or opening). This is the recommended approach to avoid race conditions that can occur with concurrent customField.setValue calls.
>
> #### Input Parameters
>
> **values** `array` *required*
>
> Array of custom field updates to apply. Must contain at least one item
>
> **objectId** `string` *required*
>
> The ID of the object to update (e.g., candidate ID, application ID, job ID, opening ID)
>
> **objectType** `string ("Application" | "Candidate" | "Job" | "Opening")` *required*
>
> The type of object being updated
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Custom Field Values Project
>
> **Slug:** `ASHBY_SET_CUSTOM_FIELD_VALUES_PROJECT`
>
> Replace a nonempty batch of distinct custom fields on an Ashby project. Includes archived projects. Use null to clear optional fields; required fields cannot be cleared. False and zero are valid. Multi-select values replace all selections. Omitted fields and unrelated properties remain unchanged. Invalid batches update nothing. Avoid concurrent updates: last completed write wins, and retrying can overwrite newer values. Requires projectsWrite, Project custom fields availability, and an effective actor allowed to edit the project. Private and API-only permissions apply; delegated humans cannot change or clear API-only fields. New User references must be active nonservice organization users visible to the actor; unchanged historical references must still belong to the organization and remain visible. Missing historical required fields do not block edits. This action performs no discovery; definition discovery separately needs hiringProcessMetadata:read and User discovery needs organization:read.
>
> #### Input Parameters
>
> **values** `array` *required*
>
> Distinct field replacements in response order. Omitted fields remain unchanged. Duplicate field IDs are rejected, including different identifiers resolving to the same field (checked by Ashby).
>
> **projectId** `string` *required*
>
> The UUID of the project to edit.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Custom Field Values User
>
> **Slug:** `ASHBY_SET_CUSTOM_FIELD_VALUES_USER`
>
> Set multiple custom field values on an Ashby employee in one call. Prefer this batch operation over concurrent user.setCustomFieldValue calls to avoid race conditions. Supply a nonempty values array; identify each field by fieldId or its exact beta referenceIdentifier. Values must match the custom field's configured type; see customField.setValue for accepted types. Returns custom field entries, not a full user object. Requires organizationWrite.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> The employee UUID to set custom field values for.
>
> **values** `array` *required*
>
> Nonempty batch of custom field updates for this employee.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set User Custom Field Value
>
> **Slug:** `ASHBY_SET_CUSTOM_FIELD_VALUE_USER`
>
> Set one custom field value on an Ashby employee. Identify the employee by userId and the field by fieldId or its beta referenceIdentifier. Supply a fieldValue matching the field's type, including explicit null. For location fields, any combination of country, region and city is accepted and geocoded; provide all three for best results. Use user.setCustomFieldValues instead when updating multiple fields on the same employee to avoid race conditions. Requires organizationWrite permission.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> The employee UUID to set the custom field value for.
>
> **fieldId** `string`
>
> Custom field definition UUID; supply this or referenceIdentifier.
>
> **fieldValue** `string` *required*
>
> Value to store, including explicit null. Type depends on the field: boolean, number, string, string array, currency, range, compensation range, or location. Location accepts any combination of country, region and city; provide all three for best geocoding results.
>
> **referenceIdentifier** `string`
>
> Beta: the field reference ID exactly as saved; supply this or fieldId.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Offer Decision Timestamp
>
> **Slug:** `ASHBY_SET_DECIDED_AT_OFFER`
>
> Update an offer's decidedAt timestamp to the time it was accepted or declined. Requires the offer ID and a UTC decision timestamp. This endpoint updates the timestamp, not the offer's acceptance or approval status. Use excludeFormDefinition to omit the form schema from the response. Requires offersWrite permission.
>
> #### Input Parameters
>
> **offerId** `string` *required*
>
> The ID of the offer whose decision timestamp to update.
>
> **decidedAt** `string` *required*
>
> The time the offer was accepted or declined, as a UTC ISO date-time ending in Z. Cannot be null.
>
> **excludeFormDefinition** `boolean`
>
> If true, omit the form definition from the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Candidate Fraud Status
>
> **Slug:** `ASHBY_SET_FRAUD_STATUS_CANDIDATE`
>
> Update a candidate's manual fraud-review status and return the updated candidate. Set Fraudulent, NotFraudulent, or Unsure; automatic statuses cannot be set here. Requires an API key with candidatesWrite permission.
>
> #### Input Parameters
>
> **candidateId** `string` *required*
>
> The ID of the candidate whose manual fraud-review status to update.
>
> **fraudStatus** `string ("Fraudulent" | "NotFraudulent" | "Unsure")` *required*
>
> The manual fraud-review status to set.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Job Status
>
> **Slug:** `ASHBY_SET_JOB_STATUS`
>
> 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.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The unique identifier (UUID) of the job to update. You can obtain this from the list\_jobs or search\_jobs actions.
>
> **status** `string ("Open" | "Closed" | "Draft")` *required*
>
> The new status to set for the job. Valid values are: 'Open' (job is actively accepting applications), 'Closed' (job is no longer accepting applications), 'Draft' (job is in preparation). Note: Some transitions may not be allowed (e.g., Closed to Open).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Opening Archived
>
> **Slug:** `ASHBY_SET_OPENING_ARCHIVED`
>
> Sets the archived state of an opening. Requires the jobsWrite permission. Use this to archive or unarchive job openings.
>
> #### Input Parameters
>
> **archive** `boolean` *required*
>
> Boolean indicating the desired archived state (true to archive, false to unarchive)
>
> **openingId** `string` *required*
>
> The unique identifier of the opening
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Opening State
>
> **Slug:** `ASHBY_SET_OPENING_OPENING_STATE`
>
> Set the workflow state of an opening (job requisition). Use this to transition an opening between states: Draft, Approved, Open, or Closed. Important notes: - When setting state to 'Closed', you must provide a closeReasonId (use LIST\_CLOSE\_REASONS to get valid IDs) - Not all state transitions are allowed by Ashby's workflow rules; the API will return an error for invalid transitions - Common valid transitions: Open ↔ Closed, Approved → Open - Returns the updated opening details including the new state, timestamps, and close reason if applicable
>
> #### Input Parameters
>
> **openingId** `string` *required*
>
> The unique identifier of the opening to update
>
> **openingState** `string` *required*
>
> The new state for the opening. Valid values: 'Draft', 'Approved', 'Open', 'Closed'. Note: Not all state transitions are allowed; the API enforces valid workflow transitions (e.g., you can transition from Open to Closed, or Closed to Open, but not from Open to Draft)
>
> **closeReasonId** `string`
>
> The ID of the close reason. Required when setting openingState to 'Closed', otherwise optional
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Status Job Posting
>
> **Slug:** `ASHBY_SET_STATUS_JOB_POSTING`
>
> Publish or unpublish an Ashby job posting by UUID. Set Published to publish a draft or Draft to unpublish a published posting. Publishing requires a title, description, and an open parent job. A valid compensation tier is also required if the organization requires compensation display. Ashby validates these existing-state prerequisites. Returns the updated posting. Requires an API key with jobsWrite permission.
>
> #### Input Parameters
>
> **status** `string ("Draft" | "Published")` *required*
>
> Set Draft to unpublish or Published to publish the posting.
>
> **jobPostingId** `string` *required*
>
> The UUID of the job posting to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Offer Acceptance Status
>
> **Slug:** `ASHBY_SET_STATUS_OFFER`
>
> Update an Ashby offer's acceptance status to Accepted, Declined, or Cancelled. Requires offersWrite permission. Ashby derives offerStatus from acceptanceStatus; offerStatus cannot be set independently. Set excludeFormDefinition=true to omit the offer form definition from the returned offer.
>
> #### Input Parameters
>
> **offerId** `string` *required*
>
> The UUID of the offer whose acceptance status should be updated.
>
> **acceptanceStatus** `string ("Accepted" | "Declined" | "Cancelled")` *required*
>
> The acceptance status to set. Ashby derives offerStatus from this value.
>
> **excludeFormDefinition** `boolean`
>
> If true, omit the form definition from the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Job Approval Process
>
> **Slug:** `ASHBY_START_APPROVAL_PROCESS_JOB`
>
> Start a job's approval process, creating an instance and submitting it to approvers. Requires approvalsWrite permission, organization approvals API access, a matching approval definition, and a job that passes approval validation. An already-pending approval returns an error rather than creating a duplicate. Job-not-found errors can also mean the API key cannot access the job. Optionally attach a plain-text or HTML note. This action submits the request; it does not approve the job.
>
> #### Input Parameters
>
> **note** `object`
>
> A note attached to the approval request.
>
> **jobId** `string` *required*
>
> The UUID of the job whose approval process should be started.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Offer Approval Process
>
> **Slug:** `ASHBY_START_APPROVAL_PROCESS_OFFER`
>
> Start approval for an offer in WaitingOnApprovalStart state. Sends approval to the configured approvers. Pass the offer version ID from offer.info or offer.list's latestVersion.id, not the offer ID. Optionally attach a note or omit the form definition from the response. Requires offersWrite.
>
> #### Input Parameters
>
> **note** `string`
>
> Optional note to attach to the approval request.
>
> **offerVersionId** `string` *required*
>
> UUID of the offer version to submit for approval. Obtain latestVersion.id from offer.info or offer.list; this is not the offer ID.
>
> **excludeFormDefinition** `boolean`
>
> If true, omit the form definition from the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Offer
>
> **Slug:** `ASHBY_START_OFFER`
>
> Create a new offer version instance for an in-progress offer process. The returned offer version can be filled out and submitted using the Create Offer action. Use this action before creating a finalized offer to initialize the offer version that will hold the offer details. After starting the offer, use the Create Offer endpoint to populate and submit the offer form. Requires the 'offersWrite' permission.
>
> #### Input Parameters
>
> **offerProcessId** `string` *required*
>
> ID of the offer process to start. This identifies the candidate's in-progress offer process for which a new version will be created.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Offer Process
>
> **Slug:** `ASHBY_START_OFFER_PROCESS`
>
> Start an offer process for a candidate's application in Ashby ATS. Use this action when you need to initiate the formal offer workflow for a candidate who has progressed through interviews and is ready to receive an offer. The application must be in the Offer stage before starting an offer process. Once started, the offer process will have a status (typically 'WaitingOnOfferCreation') and a unique identifier that can be used to track and manage the offer through completion. Requires the 'offersWrite' permission.
>
> #### Input Parameters
>
> **applicationId** `string` *required*
>
> UUID of the application to start the offer process for. The application must be in the Offer stage to start an offer process.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Sequence Draft
>
> **Slug:** `ASHBY_START_SEQUENCE`
>
> Validate and start an existing NotStarted sourcing sequence draft owned by the acting user. Starting can initiate outreach. Drafts created with x-on-behalf-of must be started with that same acting user. Inspect results.startResult.status: Blocked leaves the draft NotStarted and editable, with errors/requiredActions to resolve. Warnings and informational entries do not block starting. Started returns the updated sequence status. Missing, inaccessible, non-sourcing, or already-started sequences return sequence\_not\_found. Requires sourcingWrite permission.
>
> #### Input Parameters
>
> **sequenceId** `string` *required*
>
> The NotStarted sourcing sequence draft enrollment ID, owned by the acting user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Application Feedback
>
> **Slug:** `ASHBY_SUBMIT_APPLICATION_FEEDBACK`
>
> Submit structured feedback for an application using a feedback form. Use this for formal interview feedback and scorecards, not for informal notes or comments.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> The ID of the user the feedback will be credited to. The user must be an interviewer on the interview event that feedback is being submitted for. This is REQUIRED for proper feedback attribution.
>
> **applicationId** `string` *required*
>
> The ID of the application to submit feedback for
>
> **fieldSubmissions** `array` *required*
>
> Array of field submissions. Each item has 'path' (the field identifier) and 'value' (the submitted value). Value format depends on field type: Boolean (boolean), Date (YYYY-MM-DD string), Email (string), Number (integer), RichText (\{type: 'PlainText', value: 'text'}), Score (\{score: 1-4}), Phone/String (string), ValueSelect (string matching option), MultiValueSelect (array of strings)
>
> **formDefinitionId** `string` *required*
>
> The ID of the feedback form definition to use for this submission
>
> **interviewEventId** `string` *required*
>
> The ID of the interview event you're submitting feedback for. This is REQUIRED for proper feedback attribution.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit Application Form
>
> **Slug:** `ASHBY_SUBMIT_APPLICATION_FORM`
>
> Submit a completed application form for an Ashby job posting using JSON. Use the posting's application form definition to provide field paths and JSON values. This action does not fetch arbitrary URLs, download files, or construct multipart uploads. Unpublished postings are allowed by default; set allowSubmissionForUnpublishedJobPosting=false to reject them. Inspect results.formMessages.blocked even when success is true: a blocking rule may have blocked the application. Requires candidatesWrite permission.
>
> #### Input Parameters
>
> **tagIds** `array`
>
> Optional candidate tag UUIDs to apply, or null.
>
> **utmData** `object`
>
> Optional UTM tracking parameters.
>
> **jobPostingId** `string` *required*
>
> The UUID of the job posting to submit the application for.
>
> **applicationForm** `object` *required*
>
> The completed application form containing field submissions. JSON values only; this action does not download URLs or upload multipart files.
>
> **allowSubmissionForUnpublishedJobPosting** `boolean`
>
> If false, reject applications for unpublished postings. Defaults to true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Synchronous Report
>
> **Slug:** `ASHBY_SYNCHRONOUS_REPORT`
>
> Retrieve Ashby report data synchronously. Requires reportsRead permission. Provider timeout is 30 seconds; use report.generate for long-running reports. Inline data defaults to including headers and has a 5 MB uncompressed cap. Larger inline reports fail with ReportTooLargeForInline and URL-shaped data; request resultStyle=url to avoid that cap, with includeHeadersInData=true or omitted. URL mode may fall back to inline for single aggregate-count Show All reports or legacy cached results; inspect the returned shape, not just the input. This action does not download the presigned URL. Its body is Brotli-compressed JSON and the downloading client must decode Content-Encoding: br; do not attach Ashby API authorization to S3 downloads. Organization limits are 15 requests per minute and 3 concurrent operations, shared with report.generate; build slots can outlast the HTTP request. On 429 wait before retrying. Failed builds raise an error with reportResults retained, including any fallback download URL.
>
> #### Input Parameters
>
> **reportId** `string` *required*
>
> The UUID of the report to retrieve.
>
> **resultStyle** `string ("inline" | "url")`
>
> inline (default) embeds data up to 5 MB uncompressed; url returns a short-lived presigned S3 URL without that cap. Nullable.
>
> **includeHeadersInData** `boolean`
>
> Include column headers as the first data row (default true), or null. False leaves headers only in columnNames. URL mode requires true or omission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Transfer Application
>
> **Slug:** `ASHBY_TRANSFER_APPLICATION`
>
> Transfer an application to a different job position in Ashby ATS. Use this action to move a candidate's application from one job opening to another while optionally preserving their application history and context. This is useful when: - A candidate is better suited for a different open position - Job requirements change and the candidate should be considered for an alternative role - Internal mobility scenarios where employees are being considered for different positions The transfer will update the application's associated job, interview plan, and current interview stage. You can optionally trigger automatic activities (emails, tasks) configured for the target stage.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> UUID of the destination job to transfer the application to. Must be an existing job ID obtained from job listing endpoints.
>
> **applicationId** `string` *required*
>
> UUID of the application to transfer. Must be an existing application ID obtained from application listing endpoints.
>
> **interviewPlanId** `string` *required*
>
> UUID of the interview plan to use for the transferred application. Must be a valid interview plan associated with the destination job.
>
> **interviewStageId** `string` *required*
>
> UUID of the interview stage to place the application in after transfer. Must be a valid stage from the specified interview plan.
>
> **startAutomaticActivities** `boolean`
>
> Whether to automatically start activities configured for the target interview stage. Set to true to trigger automatic email sequences, tasks, or other activities. Defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Application
>
> **Slug:** `ASHBY_UPDATE_APPLICATION`
>
> 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.
>
> #### Input Parameters
>
> **sourceId** `string`
>
> The unique identifier (UUID) of the source to assign to this application. Get available sources from the list\_sources action. Use this to update how the candidate was sourced (e.g., 'Referral', 'LinkedIn', 'Applied').
>
> **createdAt** `string`
>
> ISO 8601 timestamp to set as the application's creation date (e.g., '2025-01-15T10:30:00.000Z'). Use this to backdate applications that were imported or created retroactively.
>
> **applicationId** `string` *required*
>
> The unique identifier (UUID) of the application to update. You can get this from the list\_applications action or application.list endpoint.
>
> **creditedToUserId** `string`
>
> The unique identifier (UUID) of the user who should be credited for this application. Get available users from the list\_users action. This is typically the recruiter or sourcer who brought in the candidate.
>
> **sendNotifications** `boolean`
>
> Whether to send notifications when updating the application. Set to false to make silent updates without triggering email notifications.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Application History
>
> **Slug:** `ASHBY_UPDATE_APPLICATION_HISTORY`
>
> 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 ASHBY\_GET\_APPLICATION\_INFO first to retrieve all existing entries, then modify and send back the full array. Requires the 'candidatesWrite' permission and the 'Allow updating application history?' setting enabled in your admin API key configuration.
>
> #### Input Parameters
>
> **applicationId** `string` *required*
>
> The unique identifier of the application whose history is being updated
>
> **applicationHistory** `array` *required*
>
> IMPORTANT: Must include the COMPLETE application history array, not just the entries being modified. Partial history will cause errors. Each entry represents a stage transition in chronological order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Approval Definition
>
> **Slug:** `ASHBY_UPDATE_APPROVAL_DEFINITION`
>
> Create or update the approval definition for an API-managed offer entity. The entity must be within scope of an Ashby approval marked as managed by the API. Use the approval entity ID, such as an offer version ID, not the offer process ID. Steps are ordered, while approvers within each step are unordered. WARNING: an empty approvalStepDefinitions list skips approval and advances the entity to its next stage; the success response then omits results. Set submitApprovalRequest=true to submit immediately, otherwise submission is manual in Ashby (default false). Requires approvalsWrite permission.
>
> #### Input Parameters
>
> **entityId** `string` *required*
>
> The approval entity UUID, such as the offer version UUID.
>
> **entityType** `string` *required*
>
> The approval entity type; must be lowercase offer.
>
> **submitApprovalRequest** `boolean`
>
> Whether to immediately submit the created approval request, or null. Defaults to false; otherwise submit manually in Ashby.
>
> **approvalStepDefinitions** `array` *required*
>
> Ordered approval steps. An empty list skips approval and advances the entity to the next stage.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Assessment
>
> **Slug:** `ASHBY_UPDATE_ASSESSMENT`
>
> Update Ashby about the status of a started assessment. Supply a millisecond Unix timestamp and status, or a cancellation reason. Providing assessment\_result signals completion and requires assessment\_profile\_url with type url. All assessment data identifiers must be unique. A status value of Started records the start timestamp. Requires candidatesWrite permission.
>
> #### Input Parameters
>
> **metadata** `array`
>
> Other assessment data, such as ETA. All assessment data identifiers must be unique.
>
> **timestamp** `number` *required*
>
> When the update occurred, in milliseconds since the Unix epoch.
>
> **assessment\_id** `string` *required*
>
> Identifier of the started assessment being updated.
>
> **cancelled\_reason** `object`
>
> Cancellation reason. Providing it signals cancellation.
>
> **assessment\_result** `object`
>
> Assessment result. Providing it signals completion.
>
> **assessment\_status** `object`
>
> Current status; a value of Started records the start timestamp. Required unless cancelled\_reason is provided.
>
> **assessment\_profile\_url** `object`
>
> Partner assessment/candidate page. Must use type url. Required when assessment\_result is provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Candidate
>
> **Slug:** `ASHBY_UPDATE_CANDIDATE`
>
> Update an existing candidate's profile information in Ashby, including contact details, employment and education information, and social profiles.
>
> #### Input Parameters
>
> **name** `string`
>
> The candidate's full name (e.g., 'John Doe')
>
> **email** `string`
>
> Primary email address for the candidate (e.g., '[john.doe@example.com](mailto:john.doe@example.com)')
>
> **school** `string`
>
> The candidate's educational institution (e.g., 'Stanford University')
>
> **company** `string`
>
> The candidate's current or most recent company name (e.g., 'Google')
>
> **position** `string`
>
> The candidate's current job title or position (e.g., 'Senior Software Engineer')
>
> **sourceId** `string`
>
> The ID of the source to associate with this candidate (from list\_sources action)
>
> **githubUrl** `string`
>
> GitHub profile URL (e.g., '[https://github.com/johndoe](https://github.com/johndoe)')
>
> **websiteUrl** `string`
>
> Personal website or portfolio URL
>
> **candidateId** `string` *required*
>
> The unique identifier (UUID) of the candidate to update. Can be obtained from list\_candidates or search\_candidates actions.
>
> **linkedInUrl** `string`
>
> LinkedIn profile URL (e.g., '[https://linkedin.com/in/johndoe](https://linkedin.com/in/johndoe)')
>
> **phoneNumber** `string`
>
> Primary phone number for the candidate (e.g., '+1 555-123-4567')
>
> **alternateEmail** `string`
>
> Secondary/alternate email address for the candidate
>
> **creditedToUserId** `string`
>
> The ID of the user to credit for this candidate (from list\_users action)
>
> **sendNotifications** `boolean`
>
> Whether to send notifications about this update (default: true)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Compensation
>
> **Slug:** `ASHBY_UPDATE_COMPENSATION_JOB`
>
> Replace a job's compensation tiers in Ashby, using components such as salary, equity, bonus, and commission. An empty tier list clears existing compensation.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The unique identifier (UUID) of the job to update compensation for. Get this from list\_jobs or search\_jobs actions.
>
> **compensationTiers** `array` *required*
>
> Array of compensation tiers for the job. Each tier can contain multiple compensation components (salary, equity, bonus, commission). At least one tier with one component is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Posting Compensation
>
> **Slug:** `ASHBY_UPDATE_COMPENSATION_JOB_POSTING`
>
> Update compensation for an existing Ashby job posting. Requires jobsWrite. A non-empty compensationTiers array replaces posting compensation and stops parent-job inheritance; null restores inheritance. Multiple tiers require titles. Set includeUnpublishedJobPostings=true for draft postings. Returns the updated posting, including configured display settings and computed compensation display; organization-level pay transparency rules can force compensation display on.
>
> #### Input Parameters
>
> **jobPostingId** `string` *required*
>
> The UUID of the job posting to update.
>
> **compensationTiers** `string` *required*
>
> Non-empty tiers replace compensation and stop inheriting from the parent job. Pass null to restore inheritance.
>
> **includeUnpublishedJobPostings** `boolean`
>
> Set true to update an unpublished (draft) posting. Required for drafts; optional for published postings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Compensation Settings
>
> **Slug:** `ASHBY_UPDATE_COMPENSATION_SETTINGS_JOB`
>
> Update compensation display settings for a specific Ashby job. Omitted fields remain untouched. Explicit null clears a job-level override to inherit from the parent brand; other values set overrides, including false. This changes display settings, not compensation tiers. Organization-level pay transparency (such as globalRequiredOnPostings) can force compensation display on regardless, so configured values may differ from candidate-visible behavior. Requires jobsWrite permission.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The UUID of the job whose compensation display settings to update.
>
> **shouldShowOnJobBoard** `boolean`
>
> Whether compensation appears on the job board listing. Omit to leave unchanged; null clears the override and inherits from the brand.
>
> **compensationPhilosophy** `object`
>
> Plain-text or HTML philosophy content.
>
> **shouldShowOnJobPostings** `boolean`
>
> Whether compensation appears on job postings. Omit to leave unchanged; null inherits from the brand. Organization-level pay transparency can force display on regardless.
>
> **compensationTierGuideUrl** `string`
>
> A URI explaining compensation tiers. Omit to leave unchanged; null clears the override and inherits from the brand.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Posting Compensation Settings
>
> **Slug:** `ASHBY_UPDATE_COMPENSATION_SETTINGS_JOB_POSTING`
>
> Update compensation display settings for one job posting, not its compensation ranges. Omit a setting to leave it unchanged, pass null to inherit from the parent job, or supply a value to override it. Set includeUnpublishedJobPostings=true for draft postings. Organization pay transparency requirements may force compensation on despite configured settings; inspect computed shouldDisplayCompensation separately. Requires an API key with jobsWrite permission.
>
> #### Input Parameters
>
> **jobPostingId** `string` *required*
>
> The job posting whose compensation display settings to update.
>
> **shouldShowOnJobBoard** `boolean`
>
> Show compensation on the job board listing. Omit to leave unchanged; null clears the override to inherit from the parent job.
>
> **compensationPhilosophy** `object`
>
> Compensation philosophy. Omit to leave unchanged; null clears the override to inherit from the parent job.
>
> **shouldShowOnJobPostings** `boolean`
>
> Show compensation on the posting detail page. Omit to leave unchanged; null inherits from the parent job. Organization pay transparency requirements may force visibility on.
>
> **compensationTierGuideUrl** `string`
>
> Compensation tier guide URL. Omit to leave unchanged; null clears the override to inherit from the parent job.
>
> **includeUnpublishedJobPostings** `boolean`
>
> Set true to allow updating an unpublished (draft) posting. Required for draft updates.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Department
>
> **Slug:** `ASHBY_UPDATE_DEPARTMENT`
>
> 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.
>
> #### Input Parameters
>
> **name** `string`
>
> The new name for the department. Supports Unicode characters for international department names. At least one field must be provided to update.
>
> **departmentId** `string` *required*
>
> The unique identifier (UUID) of the department to update. Obtain this from the list\_departments action or department.info response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Interviewer Pool
>
> **Slug:** `ASHBY_UPDATE_INTERVIEWER_POOL`
>
> Update an existing interviewer pool's title or training requirements. Interviewer pools are groups of interviewers organized by expertise or role (e.g., "Backend Engineers", "Bar Raiser Interviews"). Use this action to: - Rename an interviewer pool by updating its title - Enable or disable training requirements for the pool - Update both title and training settings simultaneously At least one of title or requiresTraining must be provided. Use LIST\_INTERVIEWER\_POOLS to get valid pool IDs. Requires hiringProcessMetadataWrite permission.
>
> #### Input Parameters
>
> **title** `string`
>
> New title/name for the interviewer pool (e.g., 'Senior Backend Engineers', 'Technical Interview Panel'). Supports Unicode characters including emojis.
>
> **requiresTraining** `boolean`
>
> Whether training is required for interviewers in this pool. When set to true, creates a training path with Shadow and ReverseShadow stages.
>
> **interviewerPoolId** `string` *required*
>
> The UUID of the interviewer pool to update. Use LIST\_INTERVIEWER\_POOLS to get valid pool IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Interview Schedule
>
> **Slug:** `ASHBY_UPDATE_INTERVIEW_SCHEDULE`
>
> Add, update or cancel events on an Ashby interview schedule. Only schedules created by the requesting API key can be updated. Supply one event or an array in interviewEvent. Include interviewEventId from interviewSchedule.create to update an existing event; omitting it creates a new event. Each event requires startTime, endTime and interviewers. Cancel one or multiple events with interviewEventIdToCancel. Cancellation with submitted feedback is blocked unless allowFeedbackDeletion=true, which permits deleting that feedback. Returns the updated schedule. Requires interviewsWrite permission.
>
> #### Input Parameters
>
> **interviewEvent** `string`
>
> One event or an array to create or update, or null. Include interviewEventId to update an existing event.
>
> **interviewScheduleId** `string` *required*
>
> Schedule UUID. Only schedules created by the requesting API key can be updated.
>
> **allowFeedbackDeletion** `boolean`
>
> Set true to allow cancelling events with submitted feedback, which deletes that feedback. Such cancellation is blocked by default.
>
> **interviewEventIdToCancel** `string`
>
> One event UUID or an array of event UUIDs to cancel; null values are accepted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job
>
> **Slug:** `ASHBY_UPDATE_JOB`
>
> 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.
>
> #### Input Parameters
>
> **jobId** `string` *required*
>
> The unique identifier (UUID) of the job to update. Get this from list\_jobs or search\_jobs actions.
>
> **title** `string`
>
> The new title for the job position (e.g., 'Senior Software Engineer', 'Product Manager - Growth')
>
> **teamId** `string`
>
> The ID of the department/team to assign the job to. Get this from list\_departments action.
>
> **locationId** `string`
>
> The ID of the office location for the job. Get this from list\_locations action.
>
> **confidential** `boolean`
>
> Whether the job should be confidential (hidden from most users). Set to true for sensitive executive searches.
>
> **customRequisitionId** `string`
>
> A custom requisition ID/number for the job (e.g., 'REQ-2024-001'). Used for internal tracking.
>
> **defaultInterviewPlanId** `string`
>
> The ID of the default interview plan to use for this job. Get this from list\_interview\_plans action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Job Posting
>
> **Slug:** `ASHBY_UPDATE_JOB_POSTING`
>
> Update an existing job posting's details including title, description, and visibility status. This action allows you to modify public job postings properties such as: - Title: Change the job posting title - Description: Update the job description (HTML format, certain tags supported) - Listing Status: Control whether the posting is publicly visible on job boards - Description Customization: Suppress opening/closing sections for full API control Use this to keep job postings current, control visibility, or customize descriptions. Requires the jobsWrite permission.
>
> #### Input Parameters
>
> **title** `string`
>
> The new title for the job posting
>
> **isListed** `boolean`
>
> Whether the job posting should be publicly listed/visible on job boards. Set to true to publish, false to unpublish.
>
> **description** `string`
>
> The new description for the job posting in HTML format. Only certain HTML tags are supported. Note: When suppressDescriptionOpening and suppressDescriptionClosing are false, some content may not be modifiable via API.
>
> **jobPostingId** `string` *required*
>
> The unique identifier of the job posting to update
>
> **suppressDescriptionClosing** `boolean`
>
> If true, suppresses the description closing section. Set to true along with suppressDescriptionOpening to fully customize the description via API.
>
> **suppressDescriptionOpening** `boolean`
>
> If true, suppresses the description opening section. Set to true along with suppressDescriptionClosing to fully customize the description via API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Location Address
>
> **Slug:** `ASHBY_UPDATE_LOCATION_ADDRESS`
>
> 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.
>
> #### Input Parameters
>
> **address** `object` *required*
>
> Address object containing postalAddress with optional fields: addressLocality (city), addressRegion (state/province), addressCountry (country), postalCode (ZIP/postal code), and streetAddress (street details). All postalAddress fields are optional, allowing partial address updates.
>
> **locationId** `string` *required*
>
> The unique identifier (UUID) of the location to update. Use list\_locations to find valid location IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Location External Name
>
> **Slug:** `ASHBY_UPDATE_LOCATION_EXTERNAL_NAME`
>
> Update a location's external (candidate-facing) name. Use this to set or clear an alternate name for a location that is displayed on job boards and used in the API.
>
> #### Input Parameters
>
> **locationId** `string` *required*
>
> The unique identifier of the location to update
>
> **externalName** `string`
>
> An alternate candidate-facing name for this location used on job boards and in the API. Pass null to clear the external name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Location Name
>
> **Slug:** `ASHBY_UPDATE_LOCATION_NAME`
>
> Update a location's name. Use this to rename an existing location. Requires the organizationWrite permission.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The new name for the location
>
> **locationId** `string` *required*
>
> The unique identifier of the location to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Location Remote Status
>
> **Slug:** `ASHBY_UPDATE_LOCATION_REMOTE_STATUS`
>
> Tool to update a location's remote status. Use when you need to mark a location as remote or non-remote. Requires organizationWrite permission.
>
> #### Input Parameters
>
> **isRemote** `boolean` *required*
>
> Whether the location is remote. Set to true for remote locations, false otherwise.
>
> **locationId** `string` *required*
>
> The unique identifier (UUID) of the location to update. Use LIST\_LOCATIONS to find valid location IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Location Workplace Type
>
> **Slug:** `ASHBY_UPDATE_LOCATION_WORKPLACE_TYPE`
>
> 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.
>
> #### Input Parameters
>
> **locationId** `string` *required*
>
> The unique identifier of the location to update
>
> **workplaceType** `string ("OnSite" | "Remote" | "Hybrid")` *required*
>
> The workplace type for the location. OnSite: employees work from the office location; Remote: employees work remotely; Hybrid: combination of on-site and remote work
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Offer
>
> **Slug:** `ASHBY_UPDATE_OFFER`
>
> Update an existing Ashby offer by submitting its form values. Creates a new offer version and retriggers any necessary approval steps; repeated calls are not a no-op. Retrieve the form with offer.info first. Ordinary fields require path. Offer custom fields may use beta referenceIdentifier instead; when both are supplied they must identify the same field, which Ashby verifies. Set excludeFormDefinition=true to omit the response form. Requires an API key with offersWrite permission.
>
> #### Input Parameters
>
> **offerId** `string` *required*
>
> The UUID of the offer to update.
>
> **offerForm** `object` *required*
>
> The offer form submission.
>
> **excludeFormDefinition** `boolean`
>
> If true, omit the form definition from the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Opening
>
> **Slug:** `ASHBY_UPDATE_OPENING`
>
> 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.
>
> #### Input Parameters
>
> **teamId** `string`
>
> The team associated with the opening
>
> **openingId** `string` *required*
>
> The unique identifier of the opening to update
>
> **identifier** `string`
>
> Custom identifier for the opening
>
> **isBackfill** `boolean`
>
> Boolean indicating if this is a backfill position
>
> **description** `string`
>
> Description of the opening
>
> **employmentType** `string`
>
> Type of employment (e.g., FullTime, PartTime, Contract)
>
> **targetHireDate** `string`
>
> Target date for hiring (ISO 8601 format)
>
> **targetStartDate** `string`
>
> Target start date for the hire (ISO 8601 format)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Project
>
> **Slug:** `ASHBY_UPDATE_PROJECT`
>
> Update a project's title or description, including archived projects. Supply at least one editable field. Omitted fields remain unchanged; null or empty descriptions clear existing content. Plain-text whitespace is preserved. Author, confidentiality, archive state, candidate memberships and custom fields are preserved. Missing historical required custom fields do not block edits. Requires projectsWrite and an effective actor allowed to edit the project, including for authorized on-behalf-of requests.
>
> #### Input Parameters
>
> **title** `string`
>
> The new project title. Omit to preserve it; null and empty strings are not accepted.
>
> **projectId** `string` *required*
>
> The UUID of the project to update.
>
> **description** `object`
>
> Plain-text or HTML description to set on the project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Selectable Values Custom Field
>
> **Slug:** `ASHBY_UPDATE_SELECTABLE_VALUES_CUSTOM_FIELD`
>
> Update the selectable values for a ValueSelect or MultiValueSelect custom field. Use this to add new options, modify existing option labels, or archive outdated options. Values are merged with existing options - matching values are updated, new values are added.
>
> #### Input Parameters
>
> **customFieldId** `string` *required*
>
> The UUID of the custom field to update. Must be a ValueSelect or MultiValueSelect field type.
>
> **selectableValues** `array` *required*
>
> Array of selectable values to merge with existing values. Values with matching 'value' fields will be updated; new values will be added. To archive a value, include it with isArchived=true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Sequence Stage
>
> **Slug:** `ASHBY_UPDATE_STAGE_SEQUENCE`
>
> Replace subject or HTML body of one email stage in a not-started sequence. Requires sourcingWrite permission and at least one of subject or body. Only supplied fields are replaced; the reusable template is unchanged. Drafts are editable only by their creating acting user, so X-On-Behalf-Of requests must keep the same user. sequence\_not\_found may mean inaccessible. HTML may preserve, move, repeat, or remove Ashby token markers returned by sequence.info or sequence.add; unknown or malformed markers cause invalid\_input. Ashby controls token identity and final send-time values. This action does not start the sequence.
>
> #### Input Parameters
>
> **body** `object`
>
> Rich-text replacement for the stage's HTML body.
>
> **stageId** `string` *required*
>
> The UUID of the email stage to update.
>
> **subject** `string`
>
> Plain-text replacement subject. Omit to leave unchanged; null is not accepted.
>
> **sequenceId** `string` *required*
>
> The UUID of the not-started sequence enrollment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User Interviewer Settings
>
> **Slug:** `ASHBY_UPDATE_USER_INTERVIEWER_SETTINGS`
>
> 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.
>
> #### Input Parameters
>
> **userId** `string` *required*
>
> The unique identifier of the user whose interviewer settings to update
>
> **dailyLimit** `integer`
>
> Daily interview limit for the user. Set to null to unset. If only weeklyLimit is provided, dailyLimit remains unchanged.
>
> **weeklyLimit** `integer`
>
> Weekly interview limit for the user. Set to null to unset. If only dailyLimit is provided, weeklyLimit remains unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File Candidate
>
> **Slug:** `ASHBY_UPLOAD_FILE_CANDIDATE`
>
> Attach an already-uploaded file to a candidate using a JSON fileHandle. First call file.createFileUploadHandle and upload the file to its presigned URL, then pass the returned handle here. This action does not upload bytes, accept local paths, or implement the multipart branch. Returns the updated candidate. Requires candidatesWrite permission.
>
> #### Input Parameters
>
> **fileHandle** `string` *required*
>
> The handle from file.createFileUploadHandle, after uploading the file to its presigned URL. Not a local path or download URL.
>
> **candidateId** `string` *required*
>
> The UUID of the candidate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Resume Candidate
>
> **Slug:** `ASHBY_UPLOAD_RESUME_CANDIDATE`
>
> Attach an uploaded resume to an existing candidate using a file handle. First call file.createFileUploadHandle and upload the resume file bytes to the returned presigned URL. Then pass that handle as resumeHandle here. This action sends JSON only, does not fetch arbitrary URLs, and does not accept multipart files or local paths. Requires candidatesWrite permission.
>
> #### Input Parameters
>
> **candidateId** `string` *required*
>
> The UUID of the candidate whose resume will be uploaded.
>
> **resumeHandle** `string` *required*
>
> Handle returned by file.createFileUploadHandle. First create the handle and upload the resume bytes to its presigned URL, then pass the handle unchanged here. This is not a file URL or local path; this action does not fetch URLs or upload file bytes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

## Triggers

> [accordion] Application Signature Request Updated
>
> **Slug:** `ASHBY_APPLICATION_SIGNATURE_REQUEST_UPDATED`
>
> **Type:** webhook
>
> Triggers when an e-signature request attached to an application — an NDA, a consent form — is sent, cancelled, completed or deleted. Signature requests on offer letters are a separate trigger, because Ashby gives the two different fields.
>
> #### Configuration
>
> **event\_type** `string ("sent" | "cancelled" | "completed" | "deleted")`
>
> Only fire on this point in the signature request's life. Ashby delivers one event per point, so leaving this unset means four deliveries per request; `completed` means the document came back signed.
>
> #### Payload
>
> **applicationId** `string` *required*
>
> Id of the application the document belongs to.
>
> **eventType** `string ("sent" | "cancelled" | "completed" | "deleted")`
>
> What happened to the signature request. `completed` means the document came back signed.

> [accordion] Application Submitted
>
> **Slug:** `ASHBY_APPLICATION_SUBMITTED`
>
> **Type:** webhook
>
> Triggers when a candidate submits an application, or a recruiter adds one by hand. Does not fire for bulk imports or integration syncs, and does not fire when an existing application later changes.
>
> #### Configuration
>
> **job\_title** `string`
>
> Only fire for applications on the job with this exact title, e.g. `Senior Backend Engineer`. Matched exactly and case-sensitively; use `ASHBY_LIST_JOBS` to find your job titles. Leave unset to fire for every job.
>
> #### Payload
>
> **application** `object` *required*
>
> The application, with its candidate, job and current stage.

> [accordion] Application Updated
>
> **Slug:** `ASHBY_APPLICATION_UPDATED`
>
> **Type:** webhook
>
> Triggers when anything on an existing application changes — its fields, custom fields, archive state, or the job it is transferred to. Also fires alongside a hire and alongside a stage change, so enabling those triggers too gives two deliveries per action.
>
> #### Configuration
>
> **application\_status** `string ("Hired" | "Archived" | "Active" | "Lead")`
>
> Only fire when the application's status after the change is this one. This is the resulting status, not a transition, so an already-archived application that is edited again fires again with `Archived`. Leave unset to fire for every status.
>
> **job\_title** `string`
>
> Only fire for applications on the job with this exact title, e.g. `Senior Backend Engineer`. Matched exactly and case-sensitively; use `ASHBY_LIST_JOBS` to find your job titles. Leave unset to fire for every job.
>
> #### Payload
>
> **application** `object` *required*
>
> The application after the change. Ashby sends no before/after diff, so which field changed is not stated.

> [accordion] Candidate Deleted
>
> **Slug:** `ASHBY_CANDIDATE_DELETED`
>
> **Type:** webhook
>
> Triggers when a candidate record is deleted from Ashby. Distinct from a merge, where the candidate's history is folded into another record rather than lost.
>
> #### Payload
>
> **candidate** `object` *required*
>
> The deleted candidate, by id only. Nothing else survives the deletion, so the id no longer resolves against Ashby.

> [accordion] Candidate Emails Changed
>
> **Slug:** `ASHBY_CANDIDATE_EMAILS_CHANGED`
>
> **Type:** webhook
>
> Triggers when a candidate's recent email messages may have changed. Carries no message content — use the watermark in the payload to refetch them; Ashby marks this webhook beta and may not enable it for every organisation.
>
> #### Payload
>
> **candidate** `object` *required*
>
> The candidate whose recent email messages should be refreshed.
>
> **observedAt** `string`
>
> ISO 8601 timestamp Ashby observed the change. Informational only.
>
> **watermark** `string` *required*
>
> Opaque token for the refresh. Pass it unchanged, with no cursor, to Ashby's `candidate.getRecentEmailMessages` within one hour — only a request carrying it is guaranteed to include the change that produced this event. After an hour it fails with `watermark_expired`. The API key doing the fetch needs the `emails:read` scope. Deliveries can be duplicated or arrive out of order, and a delayed retry carries a new watermark.

> [accordion] Candidate Hired
>
> **Slug:** `ASHBY_CANDIDATE_HIRED`
>
> **Type:** webhook
>
> Triggers when a candidate is marked hired in Ashby, including hires on confidential jobs. Pushing that hire to an HRIS is a separate, later trigger.
>
> #### Configuration
>
> **job\_title** `string`
>
> Only fire for applications on the job with this exact title, e.g. `Senior Backend Engineer`. Matched exactly and case-sensitively; use `ASHBY_LIST_JOBS` to find your job titles. Leave unset to fire for every job.
>
> #### Payload
>
> **application** `object` *required*
>
> The application, now in its hired state.
>
> **offer** `object`
>
> An offer process attached to an application.

> [accordion] Candidate Merged
>
> **Slug:** `ASHBY_CANDIDATE_MERGED`
>
> **Type:** webhook
>
> Triggers when two candidate records are merged into one. Like a deletion this is the only way to observe it, but unlike a deletion the candidate's history survives on the record named here.
>
> #### Payload
>
> **deletedCandidate** `object` *required*
>
> The candidate that was merged away. Its id no longer resolves in Ashby — repoint anything you hold against it at `mergedCandidate`.
>
> **mergedCandidate** `object` *required*
>
> The candidate that survived the merge and now holds both histories.

> [accordion] Candidate Moved To Interview Stage
>
> **Slug:** `ASHBY_CANDIDATE_MOVED_TO_INTERVIEW_STAGE`
>
> **Type:** webhook
>
> Triggers when an application moves into a different interview stage, in either direction. Ashby also emits an application-updated event for the same move, and emits this one itself when a candidate is hired.
>
> #### Configuration
>
> **interview\_stage\_title** `string`
>
> Only fire when the application moves into the stage with this exact title, e.g. `Onsite`. Matched exactly and case-sensitively; use `ASHBY_LIST_INTERVIEW_STAGES` to find a job's stage titles. Leave unset to fire for every stage.
>
> **job\_title** `string`
>
> Only fire for applications on the job with this exact title, e.g. `Senior Backend Engineer`. Matched exactly and case-sensitively; use `ASHBY_LIST_JOBS` to find your job titles. Leave unset to fire for every job.
>
> #### Payload
>
> **application** `object` *required*
>
> The application after the move. `currentInterviewStage` is the stage it moved into; Ashby does not send the stage it left, so a move backwards is indistinguishable from a move forwards.

> [accordion] Candidate Pushed To HRIS
>
> **Slug:** `ASHBY_CANDIDATE_PUSHED_TO_HRIS`
>
> **Type:** webhook
>
> Triggers when a hired candidate is pushed from Ashby into an HRIS. This is the explicit downstream hand-off, which can follow the hire itself by minutes or days; the hire fires the candidate-hired trigger.
>
> #### Configuration
>
> **job\_title** `string`
>
> Only fire for applications on the job with this exact title, e.g. `Senior Backend Engineer`. Matched exactly and case-sensitively; use `ASHBY_LIST_JOBS` to find your job titles. Leave unset to fire for every job.
>
> #### Payload
>
> **application** `object` *required*
>
> The application the pushed candidate was hired through.

> [accordion] Interview Schedule Created
>
> **Slug:** `ASHBY_INTERVIEW_SCHEDULE_CREATED`
>
> **Type:** webhook
>
> Triggers when an interview loop is first booked for an application. Ashby also emits an interview-schedule-updated event for the same booking, so enabling both gives two deliveries.
>
> #### Payload
>
> **interviewSchedule** `object` *required*
>
> The schedule, with every interview event booked within it.

> [accordion] Interview Schedule Updated
>
> **Slug:** `ASHBY_INTERVIEW_SCHEDULE_UPDATED`
>
> **Type:** webhook
>
> Triggers when a booked interview loop changes, including a change to one interview inside it. Also fires once when the loop is first booked, alongside the interview-schedule-created trigger.
>
> #### Payload
>
> **interviewSchedule** `object` *required*
>
> The schedule after the change, with every interview event booked within it. Ashby sends no before/after diff, so which event moved is not stated.

> [accordion] Job Created
>
> **Slug:** `ASHBY_JOB_CREATED`
>
> **Type:** webhook
>
> Triggers when a job — the internal requisition, not its public posting — is created. Confidential jobs are never delivered.
>
> #### Payload
>
> **job** `object` *required*
>
> The job, with its hiring team, interview plans and custom fields.

> [accordion] Job Interview Plan Switched
>
> **Slug:** `ASHBY_JOB_INTERVIEW_PLAN_SWITCHED`
>
> **Type:** webhook
>
> Triggers when a job is moved onto a different interview plan, remapping the stages of every application in flight. Ashby also emits a job-updated event for the same switch.
>
> #### Payload
>
> **fromInterviewPlan** `object`
>
> An interview plan, by id and title.
>
> **interviewStageMappings** `array`
>
> How each stage of the old plan maps onto a stage of the new one. Applications in flight were moved along these pairs.
>
> **jobId** `string`
>
> Id of the job whose interview plan was switched.
>
> **toInterviewPlan** `object`
>
> An interview plan, by id and title.

> [accordion] Job Posting Deleted
>
> **Slug:** `ASHBY_JOB_POSTING_DELETED`
>
> **Type:** webhook
>
> Triggers when a job posting is deleted. Taking a posting off its job board without deleting it fires the job-posting-unpublished trigger instead.
>
> #### Payload
>
> **jobPosting** `object` *required*
>
> The deleted posting, by id. Its own id no longer resolves against Ashby, but `jobId` still points at the job it advertised.

> [accordion] Job Posting Published
>
> **Slug:** `ASHBY_JOB_POSTING_PUBLISHED`
>
> **Type:** webhook
>
> Triggers when a job posting is published to a job board. Ashby also emits a job-posting-updated event for the same publish, so enabling both gives two deliveries.
>
> #### Configuration
>
> **department\_name** `string`
>
> Only fire for postings in the department with this exact name, e.g. `Engineering`. Matched exactly and case-sensitively; use `ASHBY_LIST_DEPARTMENTS` to find your department names. Leave unset to fire for every department.
>
> #### Payload
>
> **jobPosting** `object` *required*
>
> The posting as published, with its apply link and compensation summary.

> [accordion] Job Posting Unpublished
>
> **Slug:** `ASHBY_JOB_POSTING_UNPUBLISHED`
>
> **Type:** webhook
>
> Triggers when a job posting is removed from its job board but kept in Ashby. Deleting the posting outright fires the job-posting-deleted trigger instead.
>
> #### Configuration
>
> **department\_name** `string`
>
> Only fire for postings in the department with this exact name, e.g. `Engineering`. Matched exactly and case-sensitively; use `ASHBY_LIST_DEPARTMENTS` to find your department names. Leave unset to fire for every department.
>
> #### Payload
>
> **jobPosting** `object` *required*
>
> The posting as it stands after being taken down. `isListed` is false by definition here.

> [accordion] Job Posting Updated
>
> **Slug:** `ASHBY_JOB_POSTING_UPDATED`
>
> **Type:** webhook
>
> Triggers when anything on a job posting changes — its title, department, locations, compensation or deadline. Also fires alongside a publish and an unpublish, so enabling those triggers too gives two deliveries per action.
>
> #### Configuration
>
> **department\_name** `string`
>
> Only fire for postings in the department with this exact name, e.g. `Engineering`. Matched exactly and case-sensitively; use `ASHBY_LIST_DEPARTMENTS` to find your department names. Leave unset to fire for every department.
>
> #### Payload
>
> **jobPosting** `object` *required*
>
> The posting after the change. Ashby sends no before/after diff, so which field changed is not stated.

> [accordion] Job Updated
>
> **Slug:** `ASHBY_JOB_UPDATED`
>
> **Type:** webhook
>
> Triggers when a job — the internal requisition, not its public posting — changes, including when it opens, closes, or moves to a different interview plan. Confidential jobs are never delivered.
>
> #### Configuration
>
> **job\_status** `string ("Draft" | "Open" | "Closed" | "Archived")`
>
> Only fire when the job's status after the change is this one. This is the resulting status, not a transition, so an already-closed job that is edited again fires again with `Closed`. Leave unset to fire for every status.
>
> #### Payload
>
> **job** `object` *required*
>
> The job after the change. Ashby sends no before/after diff, so which field changed is not stated.

> [accordion] Offer Created
>
> **Slug:** `ASHBY_OFFER_CREATED`
>
> **Type:** webhook
>
> Triggers when an offer process is started for a candidate. Later changes to that offer — new versions, approvals, the candidate's response — fire the offer-updated trigger instead.
>
> #### Payload
>
> **offer** `object` *required*
>
> The offer, with its first version and the offer form's shape.

> [accordion] Offer Deleted
>
> **Slug:** `ASHBY_OFFER_DELETED`
>
> **Type:** webhook
>
> Triggers when an offer process is deleted. This is the only way to observe the deletion — a deleted offer no longer appears in any Ashby list endpoint.
>
> #### Payload
>
> **offer** `object` *required*
>
> The deleted offer, by id. Nothing else survives the deletion, so the id no longer resolves against Ashby.

> [accordion] Offer Signature Request Updated
>
> **Slug:** `ASHBY_OFFER_SIGNATURE_REQUEST_UPDATED`
>
> **Type:** webhook
>
> Triggers when an e-signature request on an offer letter is sent, cancelled, completed or deleted. Signature requests attached to an application — an NDA, a consent form — are a separate trigger, because Ashby gives the two different fields.
>
> #### Configuration
>
> **event\_type** `string ("sent" | "cancelled" | "completed" | "deleted")`
>
> Only fire on this point in the signature request's life. Ashby delivers one event per point, so leaving this unset means four deliveries per request; `completed` means the document came back signed.
>
> #### Payload
>
> **eventType** `string ("sent" | "cancelled" | "completed" | "deleted")`
>
> What happened to the signature request. `completed` means the document came back signed.
>
> **offerId** `string` *required*
>
> Id of the offer the document belongs to.
>
> **offerVersionId** `string`
>
> Id of the offer version the document was generated from.

> [accordion] Offer Updated
>
> **Slug:** `ASHBY_OFFER_UPDATED`
>
> **Type:** webhook
>
> Triggers when an offer changes — a new version is drafted, it moves through the approval chain, or the candidate accepts or declines. Creation of the offer fires the offer-created trigger instead.
>
> #### Payload
>
> **offer** `object` *required*
>
> The offer after the change. `acceptanceStatus` and `offerStatus` carry where it now stands; Ashby sends no before/after diff.

> [accordion] Opening Created
>
> **Slug:** `ASHBY_OPENING_CREATED`
>
> **Type:** webhook
>
> Triggers when an opening — Ashby's headcount record, which jobs hire against — is created. Ashby publishes no update or delete event for openings, so this is the only opening event available.
>
> #### Payload
>
> **opening** `object` *required*
>
> The opening, with its current details under `latestVersion` — including the jobs hiring against it.

> [accordion] Survey Submitted
>
> **Slug:** `ASHBY_SURVEY_SUBMITTED`
>
> **Type:** webhook
>
> Triggers when a candidate submits a survey. Ashby never includes the answers for Diversity and EEOC surveys, anonymous or not, and does not fire at all for an anonymous Candidate Experience submission.
>
> #### Configuration
>
> **survey\_type** `string ("CandidateDataConsent" | "CandidateExperience" | "Diversity" | "EEOC" | "Questionnaire")`
>
> Only fire for this kind of survey. The five kinds drive different workflows — a questionnaire feeds the scorecard, a consent form gates data processing, a candidate-experience survey feeds NPS. Leave unset to fire for every kind.
>
> #### Payload
>
> **surveySubmission** `object` *required*
>
> The submission, with the form's shape alongside the answers so each key in `submittedValues` can be resolved to its question.

> [accordion] Take-Home Assignment Assigned
>
> **Slug:** `ASHBY_TAKE_HOME_ASSIGNMENT_ASSIGNED`
>
> **Type:** webhook
>
> Triggers when a take-home assignment is issued to a candidate and enters Waiting On Submission. The candidate has not submitted anything yet.
>
> #### Payload
>
> **takeHomeAssignment** `object` *required*
>
> The take-home assignment, with its assigned reviewers. `submission` is null until the candidate hands work in.

> [accordion] Take-Home Assignment Cancelled
>
> **Slug:** `ASHBY_TAKE_HOME_ASSIGNMENT_CANCELLED`
>
> **Type:** webhook
>
> Triggers when a take-home assignment is cancelled, whether or not the candidate had already submitted.
>
> #### Payload
>
> **takeHomeAssignment** `object` *required*
>
> The take-home assignment as it stood when it was cancelled. `submission` is present only if the candidate had already handed work in.

> [accordion] Take-Home Assignment Completed
>
> **Slug:** `ASHBY_TAKE_HOME_ASSIGNMENT_COMPLETED`
>
> **Type:** webhook
>
> Triggers when a take-home assignment reaches Complete, which happens once reviewers finish rather than when the candidate submits.
>
> #### Payload
>
> **takeHomeAssignment** `object` *required*
>
> The take-home assignment, with the candidate's `submission` and each reviewer's feedback state.

> [accordion] Take-Home Assignment Submitted
>
> **Slug:** `ASHBY_TAKE_HOME_ASSIGNMENT_SUBMITTED`
>
> **Type:** webhook
>
> Triggers when a candidate submits their take-home and it enters Waiting On Feedback. Review has not happened yet — that fires the take-home-assignment-completed trigger.
>
> #### Payload
>
> **takeHomeAssignment** `object` *required*
>
> The take-home assignment, with the candidate's `submission` and the reviewers it is waiting on.
