# AshbyApi

import StarterToolInfo from "@/app/_components/starter-tool-info";
import ToolInfo from "@/app/_components/tool-info";
import Badges from "@/app/_components/badges";
import TabbedCodeBlock from "@/app/_components/tabbed-code-block";
import TableOfContents from "@/app/_components/table-of-contents";
import ToolFooter from "@/app/_components/tool-footer";
import { Callout } from "nextra/components";

<ToolInfo
  description="Tools that enable LLMs to interact directly with the Ashby API"
  author="Arcade"
  authType="API Key"
  versions={["0.1.0"]}
/>

<Badges repo="arcadeai/arcade_ashby_api" />

<StarterToolInfo toolkitName="AshbyApi" />

The AshbyApi MCP Server offers a comprehensive suite of tools for managing recruitment processes within the Ashby platform. Users can perform a variety of actions, including:

- Create, update, and manage job applications and candidates.
- Retrieve detailed information about candidates, applications, jobs, and departments.
- Manage interview schedules, feedback, and assessments.
- Handle job postings, openings, and associated locations.
- Utilize webhooks for event notifications and manage user permissions.

This server is designed to streamline the hiring process, making it easier to track candidates and manage recruitment workflows effectively.

## Available Tools

<TableOfContents
  headers={["Tool Name", "Description"]}
  data={[
    [
      "AshbyApi.GetApiKeyInfo",
      "Retrieve information about the current API key in use.",
    ],
    [
      "AshbyApi.ChangeApplicationSource",
      "Change the source of an application in Ashby.",
    ],
    [
      "AshbyApi.ChangeApplicationStage",
      "Change the stage of a candidate's application.",
    ],
    [
      "AshbyApi.CreateJobApplication",
      "Create a job application for a candidate.",
    ],
    [
      "AshbyApi.FetchApplicationDetails",
      "Fetch application details using application or form instance ID.",
    ],
    [
      "AshbyApi.ListApplications",
      "Retrieve all applications in the organization.",
    ],
    [
      "AshbyApi.TransferApplicationToJob",
      "Transfer an application to a different job.",
    ],
    [
      "AshbyApi.UpdateApplicationStatus",
      "Updates the status or details of an application.",
    ],
    [
      "AshbyApi.UpdateApplicationHistory",
      "Update the history of an application.",
    ],
    [
      "AshbyApi.GetApplicationHistory",
      "Fetch a paginated list of application history items.",
    ],
    [
      "AshbyApi.GetCandidateCriteriaEvaluations",
      "Retrieve AI evaluations for candidate job criteria.",
    ],
    [
      "AshbyApi.ListApplicationFeedback",
      "Retrieve interview feedback and scorecards for applications.",
    ],
    [
      "AshbyApi.AddHiringTeamMember",
      "Add a user to the hiring team for an application.",
    ],
    [
      "AshbyApi.RemoveHiringTeamMember",
      "Remove a user from the hiring team for an application.",
    ],
    [
      "AshbyApi.GetHiringTeamRoles",
      "Retrieve all available hiring team roles for applications.",
    ],
    [
      "AshbyApi.SubmitApplicationFeedback",
      "Submit application feedback forms with various field types.",
    ],
    ["AshbyApi.GetApprovalList", "Retrieve all approvals in the organization."],
    [
      "AshbyApi.UpdateApprovalDefinition",
      "Create or update an approval definition for an entity.",
    ],
    ["AshbyApi.ListArchiveReasons", "Retrieve a list of archive reasons."],
    [
      "AshbyApi.AddCompletedAssessmentToCandidate",
      "Adds a completed assessment to a candidate's record.",
    ],
    ["AshbyApi.StartAssessment", "Start an assessment using the Ashby API."],
    ["AshbyApi.ListAssessments", "Retrieve a list of available assessments."],
    [
      "AshbyApi.UpdateAssessmentStatus",
      "Update the status of a candidate assessment in Ashby.",
    ],
    ["AshbyApi.CancelAssessment", "Cancel an ongoing assessment."],
    [
      "AshbyApi.AddCandidateToProject",
      "Add a candidate to a specified project.",
    ],
    [
      "AshbyApi.AddCandidateTag",
      "Add a tag to a candidate in the recruitment system.",
    ],
    [
      "AshbyApi.AnonymizeCandidateData",
      "Permanently anonymize a candidate's data in the system.",
    ],
    ["AshbyApi.CreateCandidate", "Create a new candidate entry."],
    [
      "AshbyApi.CreateCandidateNote",
      "Add a note to a candidate's profile in Ashby.",
    ],
    [
      "AshbyApi.GetCandidateInformation",
      "Retrieve detailed information of a candidate using their ID.",
    ],
    [
      "AshbyApi.ListCandidates",
      "Retrieve a list of all candidates in an organization.",
    ],
    [
      "AshbyApi.ListCandidateClientInfo",
      "Retrieve client info records for a candidate.",
    ],
    [
      "AshbyApi.ListCandidateNotes",
      "Retrieve all notes associated with a candidate.",
    ],
    [
      "AshbyApi.ListCandidateProjects",
      "Retrieve all projects linked to a candidate.",
    ],
    ["AshbyApi.FindCandidates", "Search for candidates by email or name."],
    [
      "AshbyApi.UpdateCandidateInfo",
      "Update an existing candidate's information.",
    ],
    [
      "AshbyApi.CreateCandidateTag",
      "Create a new candidate tag in the Ashby system.",
    ],
    ["AshbyApi.ListCandidateTags", "Retrieve a list of all candidate tags."],
    [
      "AshbyApi.ListCloseReasons",
      "Get a list of close reasons for jobs or openings.",
    ],
    [
      "AshbyApi.ListEnabledCommunicationTemplates",
      "Retrieve all enabled communication templates.",
    ],
    ["AshbyApi.CreateCustomField", "Creates a new custom field in Ashby."],
    [
      "AshbyApi.GetCustomFieldInfo",
      "Retrieve information about a custom field.",
    ],
    ["AshbyApi.ListCustomFields", "Retrieve a list of all custom fields."],
    [
      "AshbyApi.SetCustomFieldValue",
      "Update the value of a custom field for an object.",
    ],
    [
      "AshbyApi.CreateDepartment",
      "Create a new department within an organization.",
    ],
    [
      "AshbyApi.ArchiveDepartment",
      "Archive a department within an organization.",
    ],
    ["AshbyApi.RestoreDepartment", "Restores a previously deleted department."],
    [
      "AshbyApi.GetDepartmentDetails",
      "Fetches department details using a department ID.",
    ],
    ["AshbyApi.ListDepartments", "Retrieve a list of all departments."],
    [
      "AshbyApi.MoveDepartment",
      "Relocate a department to a new parent structure.",
    ],
    [
      "AshbyApi.UpdateDepartment",
      "Update existing department details in the system.",
    ],
    [
      "AshbyApi.RetrieveCandidateFileUrl",
      "Retrieve the URL of a candidate's associated file.",
    ],
    [
      "AshbyApi.GetFeedbackFormInfo",
      "Fetch detailed information about a specific feedback form by ID.",
    ],
    ["AshbyApi.ListFeedbackForms", "Retrieve a list of all feedback forms."],
    [
      "AshbyApi.HiringTeamAddMember",
      "Adds a user to the hiring team for a job or application.",
    ],
    [
      "AshbyApi.RemoveTeamMemberFromHiring",
      "Remove a member from the hiring team at job or application level.",
    ],
    [
      "AshbyApi.ListHiringTeamRoles",
      "Retrieve possible hiring team roles within an organization.",
    ],
    [
      "AshbyApi.FetchInterviewDetails",
      "Retrieve interview details using interview ID.",
    ],
    ["AshbyApi.ListInterviews", "Retrieve a list of all scheduled interviews."],
    [
      "AshbyApi.ListInterviewEvents",
      "Retrieve a list of interview events for a schedule.",
    ],
    [
      "AshbyApi.ListInterviewPlans",
      "Fetch a list of all available interview plans.",
    ],
    [
      "AshbyApi.CancelInterviewSchedule",
      "Cancel an interview schedule using its ID.",
    ],
    [
      "AshbyApi.CreateInterviewSchedule",
      "Create a scheduled interview in Ashby.",
    ],
    [
      "AshbyApi.GetInterviewSchedules",
      "Retrieve all interview schedules for the organization.",
    ],
    [
      "AshbyApi.UpdateInterviewSchedule",
      "Update, add, or cancel interview schedule events.",
    ],
    [
      "AshbyApi.ListInterviewStages",
      "Retrieve all interview stages for an interview plan in order.",
    ],
    [
      "AshbyApi.FetchInterviewStageDetails",
      "Fetches details of a specific interview stage.",
    ],
    [
      "AshbyApi.ListInterviewStageGroups",
      "Retrieve all interview group stages in order.",
    ],
    [
      "AshbyApi.ListInterviewerPools",
      "Fetches a list of all interviewer pools.",
    ],
    [
      "AshbyApi.GetInterviewerPoolInfo",
      "Retrieve information about an interviewer pool.",
    ],
    [
      "AshbyApi.CreateInterviewerPool",
      "Creates a new interviewer pool for hiring processes.",
    ],
    ["AshbyApi.UpdateInterviewerPool", "Update an interviewer pool."],
    [
      "AshbyApi.ArchiveInterviewerPool",
      "Archive an interviewer pool when needed.",
    ],
    [
      "AshbyApi.RestoreInterviewerPool",
      "Restores an archived interviewer pool.",
    ],
    [
      "AshbyApi.AddUserToInterviewerPool",
      "Add a user to an interviewer pool in Ashby.",
    ],
    [
      "AshbyApi.RemoveUserFromInterviewerPool",
      "Remove a user from an interviewer pool.",
    ],
    [
      "AshbyApi.CreateNewJob",
      "Create a new job listing with specified details.",
    ],
    [
      "AshbyApi.GetJobDetails",
      "Retrieve detailed information about a job using its ID.",
    ],
    [
      "AshbyApi.ListAllJobs",
      "Retrieve all open, closed, and archived jobs from Ashby.",
    ],
    ["AshbyApi.SetJobStatus", "Update the status of a job by its ID."],
    ["AshbyApi.UpdateJobDetails", "Update details of an existing job."],
    ["AshbyApi.UpdateJobCompensation", "Update a job's compensation details."],
    ["AshbyApi.SearchJobsByTitle", "Search for jobs by title."],
    ["AshbyApi.ListEnabledJobBoards", "Retrieve all enabled job boards."],
    [
      "AshbyApi.JobInterviewPlanInfo",
      "Retrieve a job's interview plan details.",
    ],
    [
      "AshbyApi.GetJobPostingInfo",
      "Retrieve detailed information about a specific job posting.",
    ],
    [
      "AshbyApi.ListPublishedJobPostings",
      "Retrieve all published and publicly listed job postings.",
    ],
    [
      "AshbyApi.ListJobTemplates",
      "Retrieve all active and inactive job templates.",
    ],
    [
      "AshbyApi.UpdateJobPosting",
      "Update an existing job posting on the Ashby platform.",
    ],
    ["AshbyApi.ArchiveLocation", "Archives a location or location hierarchy."],
    ["AshbyApi.CreateLocation", "Create a location or location hierarchy."],
    [
      "AshbyApi.GetLocationDetails",
      "Retrieve detailed information for a specific location.",
    ],
    [
      "AshbyApi.ListAllLocations",
      "Retrieve a list of all available locations.",
    ],
    [
      "AshbyApi.MoveLocationInHierarchy",
      "Move a location within the organizational hierarchy.",
    ],
    [
      "AshbyApi.RestoreArchivedLocation",
      "Restores an archived location or hierarchy.",
    ],
    ["AshbyApi.UpdateLocationAddress", "Update the address of a location."],
    ["AshbyApi.UpdateLocationName", "Updates the name of a location."],
    [
      "AshbyApi.UpdateLocationRemoteStatus",
      "Update the remote status of a specific location.",
    ],
    [
      "AshbyApi.UpdateWorkplaceType",
      "Update the workplace type for a specific location.",
    ],
    [
      "AshbyApi.OfferApprovalAction",
      "Approve an offer or a specific step in the approval process.",
    ],
    ["AshbyApi.CreateOffer", "Create a new offer using specified form fields."],
    [
      "AshbyApi.GetOfferDetails",
      "Retrieve details about a specific offer using its ID.",
    ],
    [
      "AshbyApi.GetLatestOffers",
      "Retrieve the latest version of all offers available.",
    ],
    [
      "AshbyApi.CreateCandidateOfferVersion",
      "Initiate a new offer version for a candidate.",
    ],
    [
      "AshbyApi.UpdateOffer",
      "Update an existing offer and retrigger approval steps.",
    ],
    [
      "AshbyApi.StartOfferProcess",
      "Initiate an offer process for a candidate.",
    ],
    ["AshbyApi.GetOpeningInfo", "Retrieve job opening details using a UUID."],
    ["AshbyApi.ListJobOpenings", "Retrieve a list of current job openings."],
    ["AshbyApi.SearchJobOpenings", "Search for job openings by identifier."],
    ["AshbyApi.CreateJobOpening", "Create a new job opening in the system."],
    ["AshbyApi.AddJobToOpening", "Adds a job to an opening."],
    ["AshbyApi.RemoveJobFromOpening", "Remove a job from an opening."],
    ["AshbyApi.AddLocationToJobOpening", "Adds a location to a job opening."],
    [
      "AshbyApi.RemoveLocationFromOpening",
      "Remove a location from a job opening.",
    ],
    ["AshbyApi.SetOpeningState", "Update the state of a job opening."],
    [
      "AshbyApi.SetOpeningArchivedState",
      "Set or unset the archived state of a job opening.",
    ],
    ["AshbyApi.UpdateJobOpening", "Update the details of a job opening."],
    [
      "AshbyApi.GetProjectInformation",
      "Retrieve detailed information about a project.",
    ],
    ["AshbyApi.ListProjects", "Retrieve a list of projects."],
    [
      "AshbyApi.SearchProjectsByTitle",
      "Search for projects by title for quick lookups.",
    ],
    [
      "AshbyApi.CreateCandidateReferral",
      "Creates a candidate referral in the system.",
    ],
    [
      "AshbyApi.GetReferralFormInfo",
      "Fetches or creates the default referral form details.",
    ],
    [
      "AshbyApi.GenerateAndPollReport",
      "Generate a new report or poll status of report generation.",
    ],
    [
      "AshbyApi.RetrieveSyncReport",
      "Retrieve report data synchronously with Ashby.",
    ],
    [
      "AshbyApi.ListAllSources",
      "Retrieve a list of all sources for hiring processes.",
    ],
    [
      "AshbyApi.ListSourceTrackingLinks",
      "Retrieve all source custom tracking links.",
    ],
    [
      "AshbyApi.GetSurveyFormDetails",
      "Retrieve details of a survey form definition by id.",
    ],
    [
      "AshbyApi.ListSurveyFormDefinitions",
      "Retrieve all survey form definitions.",
    ],
    [
      "AshbyApi.CreateSurveyRequest",
      "Create a survey request and get a survey URL.",
    ],
    ["AshbyApi.ListSurveyRequests", "Retrieve a list of all survey requests."],
    ["AshbyApi.CreateSurveySubmission", "Create a new survey submission."],
    [
      "AshbyApi.ListSurveySubmissions",
      "Retrieve all survey submissions for a specific type.",
    ],
    [
      "AshbyApi.GetAshbyUserInfo",
      "Retrieve detailed information of a specific Ashby user.",
    ],
    [
      "AshbyApi.GetAshbyUserList",
      "Retrieve a list of all users in Ashby and their access levels.",
    ],
    ["AshbyApi.AshbyUserSearch", "Search for an Ashby user by email address."],
    [
      "AshbyApi.GetInterviewerSettings",
      "Retrieve interviewer settings for a user.",
    ],
    [
      "AshbyApi.UpdateInterviewerSettings",
      "Update interviewer settings for a user.",
    ],
    ["AshbyApi.CreateWebhookSetting", "Creates a webhook setting in Ashby."],
    [
      "AshbyApi.RetrieveWebhookInfo",
      "Retrieve detailed information on a specific webhook setting by ID.",
    ],
    [
      "AshbyApi.UpdateWebhookSetting",
      "Update a webhook setting for Ashby service.",
    ],
    ["AshbyApi.DeleteWebhookSetting", "Delete a webhook setting."],
  ]}
/>

<Callout>
  If you need to perform an action that's not listed here, you can [get in touch
  with us](mailto:contact@arcade.dev) to request a new tool, or [create your own
  tools](/guides/create-tools/tool-basics/build-mcp-server).
</Callout>

## AshbyApi.GetApiKeyInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_api_key_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_api_key_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve information about the current API key in use.

**Parameters**

- **empty_request_body** (`json`, optional) Provide an empty JSON object as the request body. This is required to make the call but should contain no data.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ChangeApplicationSource

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/change_application_source_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/change_application_source_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Change the source of an application in Ashby.

**Parameters**

- **application_source_details** (`json`, optional) JSON object containing `applicationId` and `sourceId` to specify the application and its new source.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ChangeApplicationStage

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/change_application_stage_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/change_application_stage_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Change the stage of a candidate's application.

**Parameters**

- **application_stage_change_details** (`json`, optional) A JSON object containing applicationId, interviewStageId, and optional archiveReasonId and archiveEmail details, to change the application stage.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateJobApplication

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_job_application_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_job_application_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a job application for a candidate.

**Parameters**

- **job_application_data** (`json`, optional) JSON object containing candidateId, jobId, interviewPlanId, interviewStageId, sourceId, creditedToUserId, createdAt, and applicationHistory for the job application.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.FetchApplicationDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/fetch_application_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/fetch_application_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Fetch application details using application or form instance ID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListApplications

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_applications_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_applications_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all applications in the organization.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.TransferApplicationToJob

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/transfer_application_to_job_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/transfer_application_to_job_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Transfer an application to a different job.

**Parameters**

- **application_transfer_details** (`json`, optional) A JSON object containing the details for transferring an application, including `applicationId`, `jobId`, `interviewPlanId`, `interviewStageId`, and `startAutomaticActivities`.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateApplicationStatus

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_application_status_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_application_status_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Updates the status or details of an application.

**Parameters**

- **application_update_payload** (`json`, optional) JSON object containing applicationId, sourceId, creditedToUserId, createdAt, and sendNotifications to update application details. sendNotifications controls subscriber notifications.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateApplicationHistory

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_application_history_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_application_history_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the history of an application.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetApplicationHistory

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_application_history_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_application_history_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Fetch a paginated list of application history items.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetCandidateCriteriaEvaluations

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_candidate_criteria_evaluations_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_candidate_criteria_evaluations_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve AI evaluations for candidate job criteria.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListApplicationFeedback

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_application_feedback_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_application_feedback_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve interview feedback and scorecards for applications.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AddHiringTeamMember

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/add_hiring_team_member_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/add_hiring_team_member_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Add a user to the hiring team for an application.

**Parameters**

- **hiring_team_member_details** (`json`, optional) A JSON object containing 'applicationId', 'teamMemberId', and 'roleId'. These IDs specify the application, team member, and role for adding to the hiring team.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RemoveHiringTeamMember

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/remove_hiring_team_member_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/remove_hiring_team_member_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Remove a user from the hiring team for an application.

**Parameters**

- **hiring_team_removal_details** (`json`, optional) JSON object containing applicationId, teamMemberId, and roleId for the user to be removed.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetHiringTeamRoles

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_hiring_team_roles_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_hiring_team_roles_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all available hiring team roles for applications.

**Parameters**

This tool does not take any parameters.
**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.SubmitApplicationFeedback

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/submit_application_feedback_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/submit_application_feedback_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Submit application feedback forms with various field types.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetApprovalList

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_approval_list_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_approval_list_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all approvals in the organization.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateApprovalDefinition

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_approval_definition_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_approval_definition_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create or update an approval definition for an entity.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListArchiveReasons

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_archive_reasons_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_archive_reasons_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of archive reasons.

**Parameters**

- **include_archived_interview_plans** (`boolean`, optional) Set to true to include archived interview plans in the results.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AddCompletedAssessmentToCandidate

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/add_completed_assessment_to_candidate_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/add_completed_assessment_to_candidate_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Adds a completed assessment to a candidate's record.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.StartAssessment

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/start_assessment_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/start_assessment_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Start an assessment using the Ashby API.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListAssessments

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_assessments_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_assessments_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of available assessments.

**Parameters**

This tool does not take any parameters.
**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateAssessmentStatus

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_assessment_status_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_assessment_status_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the status of a candidate assessment in Ashby.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CancelAssessment

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/cancel_assessment_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/cancel_assessment_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Cancel an ongoing assessment.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AddCandidateToProject

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/add_candidate_to_project_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/add_candidate_to_project_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Add a candidate to a specified project.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AddCandidateTag

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/add_candidate_tag_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/add_candidate_tag_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Add a tag to a candidate in the recruitment system.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AnonymizeCandidateData

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/anonymize_candidate_data_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/anonymize_candidate_data_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Permanently anonymize a candidate's data in the system.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateCandidate

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a new candidate entry.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateCandidateNote

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_note_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_note_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Add a note to a candidate's profile in Ashby.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetCandidateInformation

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_candidate_information_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_candidate_information_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve detailed information of a candidate using their ID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListCandidates

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidates_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidates_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all candidates in an organization.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListCandidateClientInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidate_client_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidate_client_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve client info records for a candidate.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListCandidateNotes

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidate_notes_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidate_notes_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all notes associated with a candidate.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListCandidateProjects

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidate_projects_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidate_projects_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all projects linked to a candidate.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.FindCandidates

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/find_candidates_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/find_candidates_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Search for candidates by email or name.

**Parameters**

- **candidate_email** (`string`, optional) The email address of the candidate to search for. Use this to refine the search results and find specific candidates.
- **candidate_name** (`string`, optional) The name of the candidate to search for in the database.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateCandidateInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_candidate_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_candidate_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update an existing candidate's information.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateCandidateTag

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_tag_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_tag_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a new candidate tag in the Ashby system.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListCandidateTags

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidate_tags_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_candidate_tags_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all candidate tags.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListCloseReasons

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_close_reasons_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_close_reasons_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Get a list of close reasons for jobs or openings.

**Parameters**

- **include_archived_reasons** (`boolean`, optional) Set to true to include archived close reasons in the response.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListEnabledCommunicationTemplates

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_enabled_communication_templates_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_enabled_communication_templates_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all enabled communication templates.

**Parameters**

This tool does not take any parameters.
**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateCustomField

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_custom_field_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_custom_field_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Creates a new custom field in Ashby.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetCustomFieldInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_custom_field_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_custom_field_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve information about a custom field.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListCustomFields

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_custom_fields_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_custom_fields_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all custom fields.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.SetCustomFieldValue

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/set_custom_field_value_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/set_custom_field_value_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the value of a custom field for an object.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateDepartment

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_department_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_department_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a new department within an organization.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ArchiveDepartment

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/archive_department_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/archive_department_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Archive a department within an organization.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RestoreDepartment

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/restore_department_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/restore_department_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Restores a previously deleted department.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetDepartmentDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_department_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_department_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Fetches department details using a department ID.

**Parameters**

- **department_id** (`json`, optional) The ID of the department to fetch details for. This is required to retrieve accurate department information.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListDepartments

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_departments_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_departments_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all departments.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.MoveDepartment

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/move_department_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/move_department_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Relocate a department to a new parent structure.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateDepartment

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_department_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_department_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update existing department details in the system.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RetrieveCandidateFileUrl

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/retrieve_candidate_file_url_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/retrieve_candidate_file_url_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve the URL of a candidate's associated file.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetFeedbackFormInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_feedback_form_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_feedback_form_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Fetch detailed information about a specific feedback form by ID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListFeedbackForms

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_feedback_forms_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_feedback_forms_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all feedback forms.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.HiringTeamAddMember

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/hiring_team_add_member_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/hiring_team_add_member_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Adds a user to the hiring team for a job or application.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RemoveTeamMemberFromHiring

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/remove_team_member_from_hiring_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/remove_team_member_from_hiring_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Remove a member from the hiring team at job or application level.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListHiringTeamRoles

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_hiring_team_roles_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_hiring_team_roles_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve possible hiring team roles within an organization.

**Parameters**

- **return_role_titles_only** (`boolean`, optional) Set to true to return only role titles. Set to false to return objects with id and title.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.FetchInterviewDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/fetch_interview_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/fetch_interview_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve interview details using interview ID.

**Parameters**

- **interview_id** (`json`, optional) The unique ID of the interview to fetch details for. This ID is required to retrieve the specific interview information.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListInterviews

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_interviews_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_interviews_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all scheduled interviews.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListInterviewEvents

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_interview_events_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_interview_events_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of interview events for a schedule.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListInterviewPlans

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_interview_plans_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_interview_plans_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Fetch a list of all available interview plans.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CancelInterviewSchedule

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/cancel_interview_schedule_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/cancel_interview_schedule_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Cancel an interview schedule using its ID.

**Parameters**

- **interview_schedule_cancel_details** (`json`, optional) A JSON object containing the ID of the interview schedule to cancel and whether rescheduling is allowed. Required JSON structure with keys 'id' and 'allowReschedule'.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateInterviewSchedule

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_interview_schedule_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_interview_schedule_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a scheduled interview in Ashby.

**Parameters**

- **interview_schedule_request** (`json`, optional) JSON object containing application ID, interview events, and extra data. Events include start time, end time, and interviewers.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetInterviewSchedules

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_interview_schedules_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_interview_schedules_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all interview schedules for the organization.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateInterviewSchedule

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_interview_schedule_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_interview_schedule_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update, add, or cancel interview schedule events.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListInterviewStages

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_interview_stages_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_interview_stages_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all interview stages for an interview plan in order.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.FetchInterviewStageDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/fetch_interview_stage_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/fetch_interview_stage_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Fetches details of a specific interview stage.

**Parameters**

- **interview_stage_id** (`json`, optional) The unique identifier of the interview stage to fetch details for. Required for retrieving the specific stage information.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListInterviewStageGroups

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_interview_stage_groups_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_interview_stage_groups_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all interview group stages in order.

**Parameters**

This tool does not take any parameters.
**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListInterviewerPools

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_interviewer_pools_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_interviewer_pools_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Fetches a list of all interviewer pools.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetInterviewerPoolInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_interviewer_pool_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_interviewer_pool_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve information about an interviewer pool.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateInterviewerPool

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_interviewer_pool_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_interviewer_pool_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Creates a new interviewer pool for hiring processes.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateInterviewerPool

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_interviewer_pool_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_interviewer_pool_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update an interviewer pool.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ArchiveInterviewerPool

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/archive_interviewer_pool_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/archive_interviewer_pool_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Archive an interviewer pool when needed.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RestoreInterviewerPool

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/restore_interviewer_pool_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/restore_interviewer_pool_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Restores an archived interviewer pool.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AddUserToInterviewerPool

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/add_user_to_interviewer_pool_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/add_user_to_interviewer_pool_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Add a user to an interviewer pool in Ashby.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RemoveUserFromInterviewerPool

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/remove_user_from_interviewer_pool_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/remove_user_from_interviewer_pool_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Remove a user from an interviewer pool.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateNewJob

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_new_job_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_new_job_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a new job listing with specified details.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetJobDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_job_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_job_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve detailed information about a job using its ID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListAllJobs

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_all_jobs_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_all_jobs_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all open, closed, and archived jobs from Ashby.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.SetJobStatus

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/set_job_status_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/set_job_status_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the status of a job by its ID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateJobDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_job_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_job_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update details of an existing job.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateJobCompensation

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_job_compensation_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_job_compensation_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update a job's compensation details.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.SearchJobsByTitle

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/search_jobs_by_title_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/search_jobs_by_title_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Search for jobs by title.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListEnabledJobBoards

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_enabled_job_boards_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_enabled_job_boards_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all enabled job boards.

**Parameters**

- **request_body_data** (`json`, optional) The JSON payload for the request. This should contain any necessary parameters for listing enabled job boards.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.JobInterviewPlanInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/job_interview_plan_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/job_interview_plan_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a job's interview plan details.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetJobPostingInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_job_posting_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_job_posting_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve detailed information about a specific job posting.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListPublishedJobPostings

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_published_job_postings_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_published_job_postings_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all published and publicly listed job postings.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListJobTemplates

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_job_templates_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_job_templates_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all active and inactive job templates.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateJobPosting

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_job_posting_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_job_posting_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update an existing job posting on the Ashby platform.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ArchiveLocation

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/archive_location_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/archive_location_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Archives a location or location hierarchy.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateLocation

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_location_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_location_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a location or location hierarchy.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetLocationDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_location_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_location_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve detailed information for a specific location.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListAllLocations

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_all_locations_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_all_locations_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all available locations.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.MoveLocationInHierarchy

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/move_location_in_hierarchy_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/move_location_in_hierarchy_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Move a location within the organizational hierarchy.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RestoreArchivedLocation

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/restore_archived_location_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/restore_archived_location_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Restores an archived location or hierarchy.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateLocationAddress

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_location_address_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_location_address_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the address of a location.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateLocationName

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_location_name_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_location_name_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Updates the name of a location.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateLocationRemoteStatus

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_location_remote_status_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_location_remote_status_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the remote status of a specific location.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateWorkplaceType

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_workplace_type_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_workplace_type_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the workplace type for a specific location.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.OfferApprovalAction

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/offer_approval_action_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/offer_approval_action_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Approve an offer or a specific step in the approval process.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateOffer

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_offer_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_offer_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a new offer using specified form fields.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetOfferDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_offer_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_offer_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve details about a specific offer using its ID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetLatestOffers

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_latest_offers_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_latest_offers_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve the latest version of all offers available.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateCandidateOfferVersion

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_offer_version_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_offer_version_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Initiate a new offer version for a candidate.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateOffer

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_offer_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_offer_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update an existing offer and retrigger approval steps.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.StartOfferProcess

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/start_offer_process_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/start_offer_process_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Initiate an offer process for a candidate.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetOpeningInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_opening_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_opening_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve job opening details using a UUID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListJobOpenings

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_job_openings_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_job_openings_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of current job openings.

**Parameters**

- **last_sync_token** (`string`, optional) Opaque token representing the last time a full set of results was fetched. Use this to sync data updates.
- **page_cursor** (`string`, optional) String indicating which page of job openings results to fetch, used for pagination.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.SearchJobOpenings

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/search_job_openings_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/search_job_openings_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Search for job openings by identifier.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateJobOpening

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_job_opening_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_job_opening_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a new job opening in the system.

**Parameters**

- **associated_job_ids** (`array[string]`, optional) Array of job IDs related to the opening.
- **department_team_id** (`string`, optional) The unique identifier for the department or team associated with the job opening.
- **employment_start_date** (`string`, optional) The date (in YYYY-MM-DD format) when the hired person is expected to start employment.
- **employment_type** (`string`, optional) The employment type for this opening. Options include: FullTime, PartTime, Intern, Contract, Temporary.
- **identifiers** (`string`, optional) Comma-separated list of jobIds, targetHireDate, targetStartDate, isBackfill, and employmentType to define job details.
- **is_backfill** (`boolean`, optional) Indicate whether the job opening is intended to backfill a previous employee's position.
- **job_description** (`string`, optional) A detailed description of the job opening, including responsibilities and qualifications.
- **location_ids** (`array[string]`, optional) A list of location IDs associated with the job opening.
- **opening_state** (`string`, optional) Specifies the state of the job opening. Options: Draft, Approved, Open, Closed. Defaults to Draft. Additional validation may be needed if not Draft.
- **target_hire_date** (`string`, optional) Specify the date (YYYY-MM-DD) by which the hire is intended to be made for the job opening.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AddJobToOpening

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/add_job_to_opening_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/add_job_to_opening_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Adds a job to an opening.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RemoveJobFromOpening

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/remove_job_from_opening_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/remove_job_from_opening_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Remove a job from an opening.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AddLocationToJobOpening

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/add_location_to_job_opening_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/add_location_to_job_opening_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Adds a location to a job opening.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RemoveLocationFromOpening

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/remove_location_from_opening_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/remove_location_from_opening_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Remove a location from a job opening.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.SetOpeningState

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/set_opening_state_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/set_opening_state_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the state of a job opening.

**Parameters**

- **close_reason_id** (`string`, optional) The ID for the reason why the opening is closed, required when setting the state to closed.
- **new_opening_state** (`string`, optional) The new state to update the job opening to. Accepted values are 'Draft', 'Approved', 'Open', 'Closed'.
- **opening_id** (`string`, optional) The unique identifier of the job opening to be updated.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.SetOpeningArchivedState

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/set_opening_archived_state_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/set_opening_archived_state_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Set or unset the archived state of a job opening.

**Parameters**

- **opening_id** (`string`, optional) The ID of the job opening to archive or unarchive.
- **set_archived_state** (`boolean`, optional) Boolean to set the archived state of a job opening. Use true to archive and false to unarchive.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateJobOpening

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_job_opening_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_job_opening_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update the details of a job opening.

**Parameters**

- **department_team_id** (`string`, optional) The unique ID of the department or team associated with the job opening.
- **employment_type** (`string`, optional) Specifies the employment type for the job opening. Can be FullTime, PartTime, Intern, Contract, or Temporary.
- **fields_to_update** (`string`, optional) Specify the fields you want to update, such as jobIds, targetHireDate, targetStartDate, isBackfill, employmentType.
- **is_backfill** (`boolean`, optional) Indicate if the opening is intended to backfill an employee. Use true for backfill, false otherwise.
- **job_description_update** (`string`, optional) The new description text for the job opening. Provide a detailed and clear update relevant to the job role.
- **opening_identifier** (`string`, optional) The unique ID of the job opening to update.
- **target_hire_date** (`string`, optional) The date in YYYY-MM-DD format by which you intend to hire for the opening.
- **target_start_date** (`string`, optional) The intended start date (in YYYY-MM-DD format) for a newly hired employee.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetProjectInformation

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_project_information_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_project_information_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve detailed information about a project.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListProjects

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_projects_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_projects_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of projects.

**Parameters**

- **last_sync_token** (`string`, optional) An opaque token from the last successful data sync. This is used to fetch updates.
- **max_items_to_return** (`integer`, optional) The maximum number of projects to return. The default and maximum value is 100.
- **page_results_cursor** (`string`, optional) An opaque cursor indicating which page of results to fetch from the project list.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.SearchProjectsByTitle

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/search_projects_by_title_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/search_projects_by_title_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Search for projects by title for quick lookups.

**Parameters**

- **project_title** (`string`, optional) The title of the project to search for. Use this to narrow down the results to specific projects based on their name.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateCandidateReferral

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_referral_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_candidate_referral_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Creates a candidate referral in the system.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetReferralFormInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_referral_form_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_referral_form_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Fetches or creates the default referral form details.

**Parameters**

This tool does not take any parameters.
**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GenerateAndPollReport

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/generate_and_poll_report_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/generate_and_poll_report_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Generate a new report or poll status of report generation.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RetrieveSyncReport

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/retrieve_sync_report_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/retrieve_sync_report_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve report data synchronously with Ashby.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListAllSources

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_all_sources_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_all_sources_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all sources for hiring processes.

**Parameters**

- **include_archived_items** (`boolean`, optional) When true, archived items are included in the results.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListSourceTrackingLinks

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_source_tracking_links_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_source_tracking_links_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all source custom tracking links.

**Parameters**

- **include_disabled_tracking_links** (`boolean`, optional) Set to true to include disabled tracking links in the list.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetSurveyFormDetails

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_survey_form_details_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_survey_form_details_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve details of a survey form definition by id.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListSurveyFormDefinitions

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_survey_form_definitions_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_survey_form_definitions_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all survey form definitions.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateSurveyRequest

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_survey_request_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_survey_request_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a survey request and get a survey URL.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListSurveyRequests

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_survey_requests_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_survey_requests_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all survey requests.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateSurveySubmission

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_survey_submission_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_survey_submission_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Create a new survey submission.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.ListSurveySubmissions

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/list_survey_submissions_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/list_survey_submissions_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve all survey submissions for a specific type.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetAshbyUserInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_ashby_user_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_ashby_user_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve detailed information of a specific Ashby user.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetAshbyUserList

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_ashby_user_list_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_ashby_user_list_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve a list of all users in Ashby and their access levels.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.AshbyUserSearch

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/ashby_user_search_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/ashby_user_search_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Search for an Ashby user by email address.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.GetInterviewerSettings

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/get_interviewer_settings_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/get_interviewer_settings_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve interviewer settings for a user.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateInterviewerSettings

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_interviewer_settings_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_interviewer_settings_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update interviewer settings for a user.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.CreateWebhookSetting

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/create_webhook_setting_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/create_webhook_setting_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Creates a webhook setting in Ashby.

**Parameters**

- **webhook_configuration** (`json`, optional) A JSON object containing configuration details for the webhook, including webhookType, requestUrl, and secretToken.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.RetrieveWebhookInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/retrieve_webhook_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/retrieve_webhook_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve detailed information on a specific webhook setting by ID.

**Parameters**

- **mode** (`Enum` [ToolMode](#toolmode), required) Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
- **request_body** (`string`, optional) Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.UpdateWebhookSetting

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/update_webhook_setting_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/update_webhook_setting_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Update a webhook setting for Ashby service.

**Parameters**

- **webhook_settings_payload** (`json`, optional) JSON object containing `webhookId`, optionally one of `enabled`, `requestUrl`, or `secretToken` to update specific settings.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## AshbyApi.DeleteWebhookSetting

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/ashby_api/delete_webhook_setting_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/ashby_api/delete_webhook_setting_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Delete a webhook setting.

**Parameters**

- **webhook_id** (`json`, optional) The unique identifier of the webhook to be deleted.

**Secrets**

This tool requires the following secrets: `ASHBY_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## Reference

Below is a reference of enumerations used by some of the tools in the AshbyApi MCP Server:

### ToolMode

- **GET_REQUEST_SCHEMA**: `get_request_schema`
- **EXECUTE**: `execute`

<ToolFooter pipPackageName="arcade_ashby_api" />