Skip to Content

Ashby API

Ashby API icon
Arcade Starter

Tools that enable LLMs to interact directly with the Ashby API

Author:Arcade
Version:2.0.0
Auth:No authentication required
141tools
141require secrets
PyPI VersionPython VersionsWheel StatusDownloadsLicense

AshbyApi enables seamless interactions with the Ashby recruitment platform, allowing LLMs to perform various recruitment tasks efficiently.

Capabilities

  • Manage candidate profiles, including adding tags and assessments.
  • Facilitate interview scheduling and maintain interview records.
  • Create and update job openings and applications.
  • Archive and restore candidates, jobs, and departments swiftly.
  • Generate and manage reports on recruitment activities.

Secrets

  • API Key: Use the ASHBY_API_KEY for authentication.

Ensure to understand the request schema to craft stringified JSON inputs for execution efficiently.

Available tools(141)

141 of 141
Tool nameDescriptionSecrets
Add a tag to a candidate in the recruitment system. Use this tool to attach a specific tag to a candidate in the Ashby recruitment platform, which helps in categorizing and managing candidates efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a candidate to a specified project. Use this tool to assign a candidate to a specific project. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Adds a completed assessment to a candidate's record. Use this tool to update a candidate's profile with a completed assessment. Requires the 'candidatesWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a user to the hiring team for an application. This tool adds an Ashby user to the hiring team at the application level. Requires candidateWrite permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Adds a job to an opening. Use this tool to add a job to an existing opening. Requires the `jobsWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Adds a location to a job opening. Use this tool to associate a specific location with a job opening. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a user to an interviewer pool in Ashby. This tool allows you to add a user to an interviewer pool using the Ashby API. Ensure you have the necessary permissions before making the call. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Permanently anonymize a candidate's data in the system. Use this tool to anonymize a candidate's data. Ensure all candidate applications are archived or marked as hired before calling this tool. This action is irreversible and requires 'candidatesWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Archive a department within an organization. Use this tool to archive a specified department within an organization. Ensure you have the necessary permissions before calling this tool. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Archive an interviewer pool when needed. Use this tool to archive an interviewer pool, typically when it's no longer needed or active. Ensure you have the necessary permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Archives a location or location hierarchy. Use this tool to archive a specific location or an entire location hierarchy when needed. It requires permission to modify organization data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Search for an Ashby user by email address. This tool is used to find and retrieve details of an Ashby user by providing their email address. It requires the `organizationRead` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Cancel an ongoing assessment. This tool is used to cancel an ongoing assessment. Call this tool when you need to stop a scheduled or active assessment. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Cancel an interview schedule by ID. Use this tool to cancel an interview schedule by its unique identifier. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Change the source of a job application. Use this tool to change the source of a job application. Requires the 'candidatesWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new candidate entry. Use this tool to create a new candidate in the system. Requires permissions to write candidates. For setting custom field values, use the custom fields endpoint. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Add a note to a candidate's profile in Ashby. This tool allows for the creation of a note on a candidate's profile, supporting HTML formatted text. It's useful for recruiters and interviewers to document additional information or insights about a candidate. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Initiate a new offer version for a candidate. Used to create and return an offer version instance for a candidate's in-progress offer process. This instance can then be filled out and submitted using the `offer.create` endpoint. Requires the `offersWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Creates a candidate referral in the system. Use this tool to create a referral for a candidate, typically when hiring or recommending someone for a position. Requires the `candidatesWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new candidate tag in the Ashby system. Use this tool to create a new tag for candidates in the Ashby system, requiring the 'hiringProcessMetadataWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Creates a new custom field in Ashby. Use this tool to create a new custom field in Ashby, granted the necessary permissions are available. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new department within an organization. This tool is used to create a new department in an organization. It requires appropriate permissions and should be called when a user needs to add a new department to their organization in the Ashby system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Creates a new interviewer pool for hiring processes. Use this tool to create an interviewer pool, which is a group of interviewers assigned for conducting interviews in a hiring process. Requires appropriate permissions to execute. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Create a new scheduled interview in Ashby. This tool creates a scheduled interview in the Ashby platform, requiring the 'interviewsWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Creates a job application for a candidate. Use this tool to create a job application for a candidate when sourcing for a job posting. Ensure you have the 'candidatesWrite' permission. This tool is not for job boards; refer to 'applicationForm.submit' for that purpose. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
1
Page 1 of 6(25 of 141)

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

AshbyApi.AddCandidateTag

Add a tag to a candidate in the recruitment system. Use this tool to attach a specific tag to a candidate in the Ashby recruitment platform, which helps in categorizing and managing candidates efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateAddTag'.
#

AshbyApi.AddCandidateToProject

Add a candidate to a specified project. Use this tool to assign a candidate to a specific project. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateaddproject'.
#

AshbyApi.AddCompletedAssessmentToCandidate

Adds a completed assessment to a candidate's record. Use this tool to update a candidate's profile with a completed assessment. Requires the 'candidatesWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'assessmentAddCompletedToCandidate'.
#

AshbyApi.AddHiringTeamMember

Add a user to the hiring team for an application. This tool adds an Ashby user to the hiring team at the application level. Requires candidateWrite permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationaddhiringteammember'.
#

AshbyApi.AddJobToOpening

Adds a job to an opening. Use this tool to add a job to an existing opening. Requires the `jobsWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingaddjob'.
#

AshbyApi.AddLocationToJobOpening

Adds a location to a job opening. Use this tool to associate a specific location with a job opening. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingaddlocation'.
#

AshbyApi.AddUserToInterviewerPool

Add a user to an interviewer pool in Ashby. This tool allows you to add a user to an interviewer pool using the Ashby API. Ensure you have the necessary permissions before making the call. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewerPoolAddUser'.
#

AshbyApi.AnonymizeCandidateData

Permanently anonymize a candidate's data in the system. Use this tool to anonymize a candidate's data. Ensure all candidate applications are archived or marked as hired before calling this tool. This action is irreversible and requires 'candidatesWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateAnonymize'.
#

AshbyApi.ArchiveDepartment

Archive a department within an organization. Use this tool to archive a specified department within an organization. Ensure you have the necessary permissions before calling this tool. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'departmentarchive'.
#

AshbyApi.ArchiveInterviewerPool

Archive an interviewer pool when needed. Use this tool to archive an interviewer pool, typically when it's no longer needed or active. Ensure you have the necessary permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewerPoolArchive'.
#

AshbyApi.ArchiveLocation

Archives a location or location hierarchy. Use this tool to archive a specific location or an entire location hierarchy when needed. It requires permission to modify organization data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationarchive'.
#

AshbyApi.AshbyUserSearch

Search for an Ashby user by email address. This tool is used to find and retrieve details of an Ashby user by providing their email address. It requires the `organizationRead` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'userSearch'.
#

AshbyApi.CancelAssessment

Cancel an ongoing assessment. This tool is used to cancel an ongoing assessment. Call this tool when you need to stop a scheduled or active assessment. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'assessmentCancel'.
#

AshbyApi.CancelInterviewSchedule

Cancel an interview schedule by ID. Use this tool to cancel an interview schedule by its unique identifier. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewScheduleCancel'.
#

AshbyApi.ChangeApplicationSource

Change the source of a job application. Use this tool to change the source of a job application. Requires the 'candidatesWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationChangeSource'.
#

AshbyApi.CreateCandidate

Create a new candidate entry. Use this tool to create a new candidate in the system. Requires permissions to write candidates. For setting custom field values, use the custom fields endpoint. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateCreate'.
#

AshbyApi.CreateCandidateNote

Add a note to a candidate's profile in Ashby. This tool allows for the creation of a note on a candidate's profile, supporting HTML formatted text. It's useful for recruiters and interviewers to document additional information or insights about a candidate. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateCreateNote'.
#

AshbyApi.CreateCandidateOfferVersion

Initiate a new offer version for a candidate. Used to create and return an offer version instance for a candidate's in-progress offer process. This instance can then be filled out and submitted using the `offer.create` endpoint. Requires the `offersWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'offerStart'.
#

AshbyApi.CreateCandidateReferral

Creates a candidate referral in the system. Use this tool to create a referral for a candidate, typically when hiring or recommending someone for a position. Requires the `candidatesWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'referralCreate'.
#

AshbyApi.CreateCandidateTag

Create a new candidate tag in the Ashby system. Use this tool to create a new tag for candidates in the Ashby system, requiring the 'hiringProcessMetadataWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidatetagcreate'.
#

AshbyApi.CreateCustomField

Creates a new custom field in Ashby. Use this tool to create a new custom field in Ashby, granted the necessary permissions are available. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'customFieldCreate'.
#

AshbyApi.CreateDepartment

Create a new department within an organization. This tool is used to create a new department in an organization. It requires appropriate permissions and should be called when a user needs to add a new department to their organization in the Ashby system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'departmentcreate'.
#

AshbyApi.CreateInterviewerPool

Creates a new interviewer pool for hiring processes. Use this tool to create an interviewer pool, which is a group of interviewers assigned for conducting interviews in a hiring process. Requires appropriate permissions to execute. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewerPoolCreate'.
#

AshbyApi.CreateInterviewSchedule

Create a new scheduled interview in Ashby. This tool creates a scheduled interview in the Ashby platform, requiring the 'interviewsWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewScheduleCreate'.
#

AshbyApi.CreateJobApplication

Creates a job application for a candidate. Use this tool to create a job application for a candidate when sourcing for a job posting. Ensure you have the 'candidatesWrite' permission. This tool is not for job boards; refer to 'applicationForm.submit' for that purpose. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationCreate'.
#

AshbyApi.CreateJobOpening

Create a new job opening in the system. Use this tool to create a new job opening. Requires 'jobsWrite' permission. For setting custom fields, use the 'customFields.setValue' endpoint.

Parameters

ParameterTypeReq.Description
associated_job_idsarray<string>OptionalArray of job IDs related to the opening.
department_team_idstringOptionalThe unique identifier for the department or team associated with the job opening.
employment_start_datestringOptionalThe date (in YYYY-MM-DD format) when the hired person is expected to start employment.
employment_typestringOptionalThe employment type for this opening. Options include: FullTime, PartTime, Intern, Contract, Temporary.
identifiersstringOptionalComma-separated list of jobIds, targetHireDate, targetStartDate, isBackfill, and employmentType to define job details.
is_backfillbooleanOptionalIndicate whether the job opening is intended to backfill a previous employee's position.
job_descriptionstringOptionalA detailed description of the job opening, including responsibilities and qualifications.
location_idsarray<string>OptionalA list of location IDs associated with the job opening.
opening_statestringOptionalSpecifies the state of the job opening. Options: Draft, Approved, Open, Closed. Defaults to Draft. Additional validation may be needed if not Draft.
target_hire_datestringOptionalSpecify the date (YYYY-MM-DD) by which the hire is intended to be made for the job opening.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingcreate'.
#

AshbyApi.CreateLocation

Create a location or location hierarchy. This tool creates a new location or a location hierarchy within the system. It is useful for adding organizational locations, such as branches or divisions. Requires organizationWrite permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationcreate'.
#

AshbyApi.CreateNewJob

Create a new job listing with specified details. Use this tool to create a new job listing. It requires permission to write jobs and can be used in conjunction with the custom fields setting tool to add additional job details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobCreate'.
#

AshbyApi.CreateOffer

Create a new offer using specified form fields. This tool is used to create a new offer by filling out various form fields. It requires the 'offersWrite' permission and supports field types such as Boolean, Currency, Date, Number, String, ValueSelect, and MultiValueSelect. Each field must be filled out with the accepted value type as per the specification. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'offerCreate'.
#

AshbyApi.CreateSurveyRequest

Create a survey request and get a survey URL. Use this tool to create a survey request for candidates and obtain a URL which can be shared with them to complete the survey. Note that this tool does not send the survey URL to the candidate automatically; it just generates the link. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'surveyRequestCreate'.
#

AshbyApi.CreateSurveySubmission

Create a new survey submission. This tool creates a new survey submission and should be called when you need to record a survey response. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'surveySubmissionCreate'.
#

AshbyApi.CreateWebhookSetting

Creates a new webhook setting in Ashby. This tool creates a webhook setting in Ashby. It should be called when you need to set up a new webhook to receive event notifications. Ensure the necessary permissions are granted. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'webhookcreate'.
#

AshbyApi.DeleteWebhookSetting

Deletes a specified webhook setting. Use this tool to delete an existing webhook setting when no longer needed, ensuring the user has the required permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'webhookdelete'.
#

AshbyApi.FetchApplicationDetails

Fetch application details using application or form instance ID. Use this tool to retrieve details of an application by providing either the application ID or the submitted form instance ID. If both are provided, the application ID is prioritized. Requires 'candidatesRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationInfo'.
#

AshbyApi.FetchInterviewStageDetails

Fetch interview stage details by ID. Use this tool to obtain detailed information about a specific interview stage by its ID. Requires the 'interviewsRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewStageInfo'.
#

AshbyApi.FindCandidates

Search for candidates by email or name. Use this tool to find candidates based on email and/or name for operations requiring a focused candidate set. Useful for building candidate autocompletes. Ensure you have the required permissions.

Parameters

ParameterTypeReq.Description
candidate_emailstringOptionalThe email address of the candidate to search for. Use this to refine the search results and find specific candidates.
candidate_namestringOptionalThe name of the candidate to search for in the database.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateSearch'.
#

AshbyApi.GenerateAndPollReport

Generate a new report or poll status of report generation. This tool generates a new report or checks the status of an existing report generation process in a two-step manner. Initially, call with a reportId to start report generation and receive a requestId. Then, poll using both reportId and requestId until the report's status is complete or failed. Ideal for asynchronous report operations that exceed 30 seconds. Requires `reportsRead` permission. If rate limits are exceeded, consider using the synchronous endpoint. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'reportGenerate'.
#

AshbyApi.GetApiKeyInfo

Retrieve information about the current API key. This tool retrieves details about the API key being used for requests. It requires the 'apiKeysRead' permission and is essential for verifying or monitoring API key usage and access.

Parameters

No parameters required.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'apiKeyInfo'.
#

AshbyApi.GetApplicationHistory

Fetch a paginated list of application history items. Use this tool to obtain detailed history records of an application, including updates and changes over time. Useful for tracking application progress or changes in candidate information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationListHistory'.
#

AshbyApi.GetApprovalList

Retrieve all approvals in the organization. This tool retrieves all approvals within the organization. It can optionally filter results by entity type and entity ID. Ensure the 'approvalsRead' permission is available when using this tool. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'approvalList'.
#

AshbyApi.GetAshbyUserInfo

Retrieve detailed information of a specific Ashby user. Use this tool to get detailed information about a specific user in Ashby by their user ID. Requires the 'organizationRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'userInfo'.
#

AshbyApi.GetAshbyUserList

Retrieve a list of all users in Ashby and their access levels. Call this tool to get a list of all users in Ashby, including their global roles which indicate their access levels. Useful for understanding user permissions and roles within an organization on Ashby. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'userList'.
#

AshbyApi.GetCandidateCriteriaEvaluations

Retrieve AI evaluations for candidate job criteria. Fetch AI-generated evaluations assessing how well a candidate meets job requirements, including outcome and reasoning details. Requires specific permissions and enabled features. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationListCriteriaEvaluations'.
#

AshbyApi.GetCandidateInformation

Retrieve detailed information of a candidate using their ID. This tool retrieves comprehensive information about a candidate based on their unique ID, ensuring the caller has the necessary permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateInfo'.
#

AshbyApi.GetCustomFieldInfo

Retrieve information about a custom field. Get details about a custom field, requiring the 'hiringProcessMetadataRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'customFieldInfo'.
#

AshbyApi.GetDepartmentInfo

Fetch department details by ID. Use this tool to retrieve detailed information about a department by providing its ID. It's useful for getting specifics on organization departments. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'departmentInfo'.
#

AshbyApi.GetFeedbackFormInfo

Fetch detailed information about a specific feedback form by ID. Use this tool to retrieve information about a single feedback form based on its ID, useful for understanding the content and structure of the feedback form. Ensure the necessary permissions are in place. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'feedbackFormDefinitionInfo'.
#

AshbyApi.GetHiringTeamRoles

Retrieve all available hiring team roles for applications. This tool fetches all available roles within the hiring team for applications in the organization. Requires candidatesRead permission.

Parameters

No parameters required.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationHiringTeamRoleList'.
#

AshbyApi.GetInterviewDetails

Retrieve detailed information about a specific interview. This tool is used to fetch interview details using a specific interview ID from the Ashby service. It requires the `interviewsRead` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewInfo'.
#

AshbyApi.GetInterviewerPoolInfo

Retrieve information about an interviewer pool. Use this tool to get details about an interviewer pool from Ashby. Requires the 'hiringProcessMetadataRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewerPoolInfo'.
#

AshbyApi.GetInterviewerSettings

Retrieve interviewer settings for a user. This tool retrieves the interviewer settings for a specified user in the organization. It requires the 'organizationRead' permission to access user information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'userInterviewerSettings'.
#

AshbyApi.GetInterviewSchedules

Retrieve all interview schedules for the organization. This tool is used to obtain a list of all interview schedules within an organization. It is ideal for managing or reviewing interview timelines and requires the 'interviewsRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewScheduleList'.
#

AshbyApi.GetJobDetails

Retrieve detailed information about a job using its ID. This tool provides comprehensive details about a specific job when given the job ID. It should be used when there's a need to gather information about job specifics, such as title, description, and requirements. Requires appropriate permissions to access job data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobInfo'.
#

AshbyApi.GetJobPostingInfo

Retrieve detailed information about a specific job posting. This tool retrieves comprehensive details about a specific job posting, including data for rich search results and application form definitions. It is useful for accessing detailed job information to present on websites or applications. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobPostingInfo'.
#

AshbyApi.GetLatestOffers

Retrieve the latest version of all offers available. Use this tool to get a list of all offers with their latest version from Ashby. Requires offersRead permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'offerList'.
#

AshbyApi.GetLocationDetails

Retrieve detailed information for a specific location. Use this tool to obtain detailed information about a specific location by its ID. This requires the organizationRead permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationInfo'.
#

AshbyApi.GetOfferDetails

Retrieve details about a specific offer using its ID. Use this tool to obtain detailed information about a specific offer by providing its ID. Requires the necessary permission to access the offer details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'offerInfo'.
#

AshbyApi.GetOpeningInfo

Retrieve job opening details using a UUID. Call this tool to get specific information about a job opening identified by its UUID. Useful for accessing job details when the UUID is known and the `jobsRead` permission is granted. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openinginfo'.
#

AshbyApi.GetProjectInformation

Retrieve detailed information about a project. This tool retrieves detailed information about a project using its UUID. It requires the 'jobsRead' permission. Use it to access comprehensive project data when given a valid UUID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'projectinfo'.
#

AshbyApi.GetReferralFormInfo

Fetches or creates the default referral form details. Use this tool to obtain the default referral form information. If no form exists, a default one will be created. Ensure that the 'hiringProcessMetadataRead' permission is granted.

Parameters

No parameters required.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'referralFormInfo'.
#

AshbyApi.GetSurveyFormDetails

Retrieve details of a survey form definition by id. Use this tool to get details about a specific survey form definition using its id. Requires the hiringProcessMetadataRead permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'surveyFormDefinitionInfo'.
#

AshbyApi.HiringTeamAddMember

Adds a user to the hiring team for a job or application. This tool is used to add an Ashby user to a hiring team at the application, job, or opening level. It requires the `organizationWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'hiringteamaddmember'.
#

AshbyApi.JobInterviewPlanInfo

Retrieve a job's interview plan details. Fetches the interview plan for a specific job, detailing the activities and interviews required at each stage. Useful for understanding the scheduling needs and process of a job interview. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobInterviewPlanInfo'.
#

AshbyApi.ListAllJobs

Retrieve all open, closed, and archived jobs from Ashby. This tool is used to list all jobs, including open, closed, and archived ones. It can also include draft jobs if specified in the status parameter. Useful for accessing comprehensive job listings efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobList'.
#

AshbyApi.ListAllLocations

Retrieve a list of all available locations. Use this tool to obtain a complete list of locations, excluding regions. Ensure you have the 'organizationRead' permission to access this data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationlist'.
#

AshbyApi.ListAllSources

Retrieve a list of all sources for hiring processes. Use this tool to obtain a comprehensive list of sources related to hiring processes. It requires the 'hiringProcessMetadataRead' permission to access the data.

Parameters

ParameterTypeReq.Description
include_archived_itemsbooleanOptionalWhen true, archived items are included in the results.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'sourcelist'.
#

AshbyApi.ListApplicationFeedback

Retrieve interview feedback and scorecards for applications. This tool retrieves all interview scorecards and feedback submissions associated with a specific application, including form structure, submitted responses, and interview context. Useful for assessing candidate performance through submitted feedback. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationFeedbackList'.
#

AshbyApi.ListApplications

Retrieve all applications in the organization. Use this tool to get a comprehensive list of all candidate applications within your organization. Requires 'candidatesRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationList'.
#

AshbyApi.ListArchiveReasons

Retrieve a list of archive reasons. Use this tool to get a list of reasons for archiving within the Ashby service. Requires the 'hiringProcessMetadataRead' permission.

Parameters

ParameterTypeReq.Description
include_archived_interview_plansbooleanOptionalSet to true to include archived interview plans in the results.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'archivereasonlist'.
#

AshbyApi.ListAssessments

Retrieve a list of available assessments. This tool calls the partner's API to list all assessments supported by them. It is used to obtain the current assessment offerings.

Parameters

No parameters required.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'assessmentList'.
#

AshbyApi.ListCandidateClientInfo

Retrieve client info records for a candidate. Use this tool to list all client information records for a specific candidate. Requires candidatesRead permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateListClientInfo'.
#

AshbyApi.ListCandidateNotes

Retrieve all notes associated with a candidate. Use this tool to retrieve all notes related to a specific candidate. This is useful for reviewing feedback or comments made during the recruitment process. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateListNotes'.
#

AshbyApi.ListCandidateProjects

Retrieve all projects linked to a candidate. Use this tool to list all projects associated with a specific candidate. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateListProjects'.
#

AshbyApi.ListCandidates

Retrieve a list of all candidates in an organization. Use this tool to get a comprehensive list of all candidates within your organization. Useful for accessing candidate data for recruitment or management purposes. Requires 'candidatesRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateList'.
#

AshbyApi.ListCandidateTags

Retrieve a list of all candidate tags. Use this tool to get a comprehensive list of candidate tags. Requires the hiringProcessMetadataRead permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateTagList'.
#

AshbyApi.ListCloseReasons

Get a list of close reasons for jobs or openings. Use this tool to retrieve all the reasons for closing jobs or openings. Useful for understanding job status changes. Requires hiring process metadata read permissions.

Parameters

ParameterTypeReq.Description
include_archived_reasonsbooleanOptionalSet to true to include archived close reasons in the response.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'closeReasonList'.
#

AshbyApi.ListCustomFields

Retrieve a list of all custom fields. Use this tool to get a list of all custom fields available in the system. This action requires the 'hiringProcessMetadataRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'customFieldList'.
#

AshbyApi.ListDepartments

Retrieve a list of all departments. Use this tool to get a complete list of all departments within the organization. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'departmentList'.
#

AshbyApi.ListEnabledCommunicationTemplates

Retrieve all enabled communication templates. Use this tool to retrieve a list of all enabled communication templates in the system. Useful for managing or viewing templates that are currently active.

Parameters

No parameters required.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'communicationTemplateList'.
#

AshbyApi.ListEnabledJobBoards

Retrieve a list of all enabled job boards. Use this tool to get information on currently enabled job boards. Ideal for understanding which job boards are active and available for use.

Parameters

No parameters required.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobBoardList'.
#

AshbyApi.ListFeedbackForms

Retrieve a list of all feedback forms. Call this tool to obtain a list of all feedback forms. Requires 'hiringProcessMetadataRead' permission for access. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'feedbackFormDefinitionList'.
#

AshbyApi.ListHiringTeamRoles

Retrieve possible hiring team roles within an organization. Call this tool to get a list of hiring team roles for an organization. Useful for understanding the roles involved in hiring processes. Ensure you have the 'organizationRead' permission to use this tool.

Parameters

ParameterTypeReq.Description
return_role_titles_onlybooleanOptionalSet to true to return only role titles. Set to false to return objects with id and title.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'hiringteamrolelist'.
#

AshbyApi.ListInterviewerPools

Fetches a list of all interviewer pools. Use this tool to retrieve a complete list of interviewer pools. It requires the `hiringProcessMetadataRead` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewerPoolList'.
#

AshbyApi.ListInterviewEvents

Retrieve a list of interview events for a schedule. Use this tool to obtain a list of interview events linked to a specified interview schedule. It requires the necessary read permissions for accessing interview data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewEventList'.
#

AshbyApi.ListInterviewPlans

Fetch a list of all available interview plans. Use this tool to retrieve a list of all interview plans from Ashby. Ideal for obtaining current interview structures and details. Ensure the `interviewsRead` permission is granted before use. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewPlanList'.
#

AshbyApi.ListInterviews

Retrieve a list of all scheduled interviews. Use this tool to get a comprehensive list of all interviews. This is useful for checking scheduled, completed, or upcoming interviews. Ensure you have the required permissions to access this information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewList'.
#

AshbyApi.ListInterviewStageGroups

Retrieve all interview group stages in order. Use this tool to list all the interview group stages for a specific interview plan. This operation requires the 'interviewsRead' permission.

Parameters

No parameters required.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewStageGroupList'.
#

AshbyApi.ListInterviewStages

Retrieve all interview stages for an interview plan in order. Use to obtain a list of all interview stages for a specific interview plan, ensuring they are in the correct order. Useful for understanding the interview process structure. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewStageList'.
#

AshbyApi.ListJobOpenings

Retrieve a list of current job openings. Used to fetch a list of available job openings from the Ashby platform. Requires the 'jobsRead' permission to access opening list information.

Parameters

ParameterTypeReq.Description
last_sync_tokenstringOptionalOpaque token representing the last time a full set of results was fetched. Use this to sync data updates.
page_cursorstringOptionalString indicating which page of job openings results to fetch, used for pagination.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openinglist'.
#

AshbyApi.ListJobTemplates

Retrieve all active and inactive job templates. Use this tool to obtain a list of all job templates, both active and inactive. Useful for managing and reviewing job templates. Requires 'jobsRead' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobTemplateList'.
#

AshbyApi.ListProjects

Retrieve a list of projects. Use this tool to obtain a list of projects. Requires the 'candidatesRead' permission.

Parameters

ParameterTypeReq.Description
last_sync_tokenstringOptionalAn opaque token from the last successful data sync. This is used to fetch updates.
max_items_to_returnintegerOptionalThe maximum number of projects to return. The default and maximum value is 100.
page_results_cursorstringOptionalAn opaque cursor indicating which page of results to fetch from the project list.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'projectlist'.
#

AshbyApi.ListPublishedJobPostings

Retrieve all published and publicly listed job postings. Use this tool to get a list of job postings that are published and set for public display. Ensure to set the `listedOnly` parameter to `true` to avoid exposing unlisted jobs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobPostingList'.
#

AshbyApi.ListSurveyFormDefinitions

Retrieve all survey form definitions. Fetches a list of all available survey form definitions. Useful for obtaining the structure and details of surveys used in the hiring process. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'surveyFormDefinitionList'.
#

AshbyApi.ListSurveyRequests

Retrieve a list of all survey requests. Call this tool to get an overview of all survey requests currently listed. Useful for accessing details on candidate surveys when you have the necessary permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'surveyRequestList'.
#

AshbyApi.ListSurveySubmissions

Retrieve all survey submissions for a specific type. Use this tool to obtain a list of all survey submissions associated with a particular survey type. Useful for analyzing survey results or monitoring participation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'surveySubmissionList'.
#

AshbyApi.MoveDepartment

Relocate a department to a new parent structure. This tool is used to move a department to a different parent structure within an organization. Requires appropriate permissions to execute. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'departmentmove'.
#

AshbyApi.MoveLocationInHierarchy

Move a location within the organizational hierarchy. This tool is used to move a location in the location hierarchy. It requires the organizationWrite permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationmove'.
#

AshbyApi.OfferApprovalAction

Approve an offer or a specific step in the approval process. This tool approves an entire offer or a specific step within an offer's approval process. Use it to mimic the "Force Approve" function in Ashby, requiring the `offersWrite` permission. Call without `approvalStepId` and `userId` to approve the whole process, or provide both to approve a specific step. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'offerApprove'.
#

AshbyApi.RemoveHiringTeamMember

Remove a user from the hiring team at the application level. This tool removes an Ashby user from the hiring team for a specific application. It requires the `candidateWrite` permission to perform the action. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationremovehiringteammember'.
#

AshbyApi.RemoveJobFromOpening

Remove a job from an opening. Use this tool to remove a job from an opening. This action requires the 'jobsWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingremovejob'.
#

AshbyApi.RemoveLocationFromOpening

Remove a location from a job opening. This tool is used to remove a specified location from a job opening. It requires the `jobsWrite` permission and should be called when modifying job openings to update their location details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingremovelocation'.
#

AshbyApi.RemoveTeamMemberFromHiring

Remove a member from the hiring team at job or application level. This tool is used to remove an Ashby user from the hiring team for a specific application, job, or opening level. It requires the organization's write permission to perform the operation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'hiringteamremovemember'.
#

AshbyApi.RemoveUserFromInterviewerPool

Remove a user from an interviewer pool. Use this tool to remove a specific user from an interviewer pool. Ensure you have the necessary permissions before making this call. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewerPoolRemoveUser'.
#

AshbyApi.RestoreArchivedLocation

Restores an archived location or hierarchy. Use this tool to restore an archived location or location hierarchy in the system. Requires organizationWrite permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationrestore'.
#

AshbyApi.RestoreDepartment

Restores a previously deleted department. Use this tool to restore a department that was previously deleted. This requires the organizationWrite permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'departmentrestore'.
#

AshbyApi.RestoreInterviewerPool

Restores an archived interviewer pool. Use this tool to reactivate an interviewer pool that was previously archived. Ensure the necessary permissions are in place before performing this action. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewerPool.restore'.
#

AshbyApi.RetrieveCandidateFileUrl

Retrieve the URL of a candidate's associated file. Use this tool to retrieve the URL of a file linked to a specific candidate. Ensure you have the required 'candidatesRead' permission. Note that using Ashby demo data may cause errors; create a test candidate for testing. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'fileInfo'.
#

AshbyApi.RetrieveSyncReport

Retrieve report data synchronously with Ashby. Call this tool to retrieve report data synchronously using Ashby's reportSynchronous endpoint. Use it when a quick report access is needed and is within the provided time constraints and limits. For longer or more resource-intensive reports, consider using asynchronous alternatives. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'reportSynchronous'.
#

AshbyApi.RetrieveWebhookInfo

Retrieve detailed information on a specific webhook setting by ID. This tool fetches detailed information about a specified webhook setting based on its ID. It is useful for understanding configuration details and is to be used when identifying the specifics of a webhook is necessary. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'webhookInfo'.
#

AshbyApi.SearchJobOpenings

Search for job openings by identifier. Use this tool to search for job openings by their identifier. Requires appropriate permissions to access the data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingsearch'.
#

AshbyApi.SearchJobsByTitle

Search for jobs by title. Use this tool to find job listings by specifying the job title. This is useful for locating specific job openings across various industries and locations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobSearch'.
#

AshbyApi.SearchProjectsByTitle

Search for projects by title for quick lookups. This tool allows you to search for projects by their titles, returning up to 100 results. Use it when you need to quickly find a specific project or perform operations that require a small set of project results.

Parameters

ParameterTypeReq.Description
project_titlestringOptionalThe title of the project to search for. Use this to narrow down the results to specific projects based on their name.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'projectSearch'.
#

AshbyApi.SetCustomFieldValue

Update the value of a custom field for an object. Use this tool to set the value of a custom field for a specified object, requiring specific data types based on the field. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'customFieldSetValue'.
#

AshbyApi.SetJobStatus

Update the status of a job by its ID. This tool updates the status of a job based on its ID. It validates transitions between statuses: Drafts can be changed to Open or Archived, Open jobs to Closed, Closed jobs to Draft or Archived, and Archived jobs to Draft. It requires the 'jobsWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobSetStatus'.
#

AshbyApi.SetOpeningArchivedState

Set or unset the archived state of a job opening. Use this tool to change the archived status of a specific job opening. Useful when needing to manage the visibility or status of job opportunities in a system, requiring 'jobsWrite' permission.

Parameters

ParameterTypeReq.Description
opening_idstringOptionalThe ID of the job opening to archive or unarchive.
set_archived_statebooleanOptionalBoolean to set the archived state of a job opening. Use true to archive and false to unarchive.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingsetarchived'.
#

AshbyApi.SetOpeningState

Update the state of a job opening. This tool updates the state of a job opening in the Ashby platform. It should be called when it's necessary to change the status of an opening, requiring the `jobsWrite` permission.

Parameters

ParameterTypeReq.Description
close_reason_idstringOptionalThe ID for the reason why the opening is closed, required when setting the state to closed.
new_opening_statestringOptionalThe new state to update the job opening to. Accepted values are 'Draft', 'Approved', 'Open', 'Closed'.
opening_idstringOptionalThe unique identifier of the job opening to be updated.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingsetopeningstate'.
#

AshbyApi.StartAssessment

Start an assessment using the Ashby API. This tool initiates an assessment process via the Ashby platform. It should be called when an assessment needs to be started and provides confirmation once initiated. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'assessmentStart'.
#

AshbyApi.StartOfferProcess

Initiate an offer process for a candidate. Use this tool to start an offer process for a candidate. Requires the 'offersWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'offerProcess.start'.
#

AshbyApi.SubmitApplicationFeedback

Submit application feedback forms with various field types. This tool allows you to submit application feedback forms supporting multiple field types such as boolean, date, email, number, text, score, phone, and select options. It requires the `candidatesWrite` permission and returns the submitted feedback with the field paths and values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationfeedbacksubmit'.
#

AshbyApi.TransferJobApplication

Transfer a candidate's application to a different job. Use this tool to move a candidate's application to a different position. Requires the `candidatesWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationTransfer'.
#

AshbyApi.UpdateApplication

Update an application status or details. Use this tool to update the details of an application. Useful for modifying application statuses or details. Requires 'candidatesWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationUpdate'.
#

AshbyApi.UpdateApplicationHistory

Update the history of an application. This tool updates the history of an application, such as setting the entered stage time or deleting a history event. It requires the 'candidatesWrite' permission and the appropriate settings in your admin API key permissions configuration. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationUpdateHistory'.
#

AshbyApi.UpdateApplicationStage

Change the stage of an application. Use this tool to update the stage of a job application. This operation requires the 'candidatesWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'applicationChangeStage'.
#

AshbyApi.UpdateApprovalDefinition

Create or update an approval definition for an entity. This tool updates or creates an approval definition for an entity that requires approval in Ashby. It can override the current definition or create a new one, based on the provided parameters. The tool is only applicable for entities that are within the scope of an approval managed by the API. If no approval steps are provided, the approval process is skipped. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'approvalDefinitionUpdate'.
#

AshbyApi.UpdateAssessmentStatus

Update the status of a candidate assessment in Ashby. Use this tool to update the status of a started assessment in Ashby. Requires 'candidatesWrite' permission. Provide 'assessment_status' unless 'cancelled_reason' is given. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'assessmentUpdate'.
#

AshbyApi.UpdateCandidateInfo

Update an existing candidate's information. Use this tool to update the details of an existing candidate. Make sure you have the required permissions. For setting custom field values, use the `customFields.setValue` endpoint. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'candidateUpdate'.
#

AshbyApi.UpdateDepartment

Update existing department details in the system. This tool updates the details of a specific department within an organization. It requires the 'organizationWrite' permission to execute successfully. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'departmentupdate'.
#

AshbyApi.UpdateInterviewerPool

Update an interviewer pool. Use this tool to update details of an interviewer pool. Requires specific permissions to execute. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewerPoolUpdate'.
#

AshbyApi.UpdateInterviewerSettings

Update interviewer settings for a user. Use this tool to update the interviewer settings for a user, such as setting or unsetting limits. Either one or both limits can be changed. Requires 'organizationWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'userUpdateInterviewerSettings'.
#

AshbyApi.UpdateInterviewSchedule

Update, add, or cancel interview schedule events. This tool allows updating, adding, or canceling events in an interview schedule. It should be called to manage interview schedules effectively. Requires 'interviewsWrite' permission and the event's 'interviewEventId' to proceed with updates. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'interviewScheduleUpdate'.
#

AshbyApi.UpdateJobCompensation

Update a job's compensation details. Use this tool to modify the compensation tiers of an existing job. It requires the 'jobsWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobUpdateCompensation'.
#

AshbyApi.UpdateJobDetails

Update details of an existing job. Use this tool to update information for an existing job listing. This tool requires specific write permissions to execute successfully. For custom fields, utilize a separate endpoint. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobUpdate'.
#

AshbyApi.UpdateJobOpening

Update the details of a job opening. This tool updates the details of a specified job opening. It requires the 'jobsWrite' permission. For setting custom field values on openings, use the dedicated customFields.setValue endpoint.

Parameters

ParameterTypeReq.Description
department_team_idstringOptionalThe unique ID of the department or team associated with the job opening.
employment_typestringOptionalSpecifies the employment type for the job opening. Can be FullTime, PartTime, Intern, Contract, or Temporary.
fields_to_updatestringOptionalSpecify the fields you want to update, such as jobIds, targetHireDate, targetStartDate, isBackfill, employmentType.
is_backfillbooleanOptionalIndicate if the opening is intended to backfill an employee. Use true for backfill, false otherwise.
job_description_updatestringOptionalThe new description text for the job opening. Provide a detailed and clear update relevant to the job role.
opening_identifierstringOptionalThe unique ID of the job opening to update.
target_hire_datestringOptionalThe date in YYYY-MM-DD format by which you intend to hire for the opening.
target_start_datestringOptionalThe intended start date (in YYYY-MM-DD format) for a newly hired employee.

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'openingupdate'.
#

AshbyApi.UpdateJobPosting

Update an existing job posting on the Ashby platform. Use this tool to update details of an existing job posting. Requires 'jobsWrite' permission. Note: To modify job description content, use `descriptionParts.descriptionBody` and set both suppressDescriptionOpening and suppressDescriptionClosing to true. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'jobPostingUpdate'.
#

AshbyApi.UpdateLocationAddress

Update the address of a location. This tool updates the address of a specified location or location hierarchy. It should be called when an address change is needed. Requires organization write permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationupdateaddress'.
#

AshbyApi.UpdateLocationName

Updates the name of a location. Use this tool to update the name of a location. Ensure you have the required 'organizationWrite' permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationupdateName'.
#

AshbyApi.UpdateLocationRemoteStatus

Update the remote status of a specific location. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationupdateremotestatus'.
#

AshbyApi.UpdateOffer

Update an existing offer and retrigger approval steps. Use this tool to update an existing offer with new values across various field types like Boolean, Currency, Date, etc. This action will create a new version of the offer and initiate any necessary approval processes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'offerUpdate'.
#

AshbyApi.UpdateWebhookSettings

Update settings for an existing webhook. Use this tool to update webhook settings such as enabling/disabling, changing the request URL, or updating the secret token. Requires appropriate permissions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'webhookupdate'.
#

AshbyApi.UpdateWorkplaceType

Update the workplace type for a specific location. Use this tool to modify the workplace type of a given location within an organization. This operation requires the `organizationWrite` permission. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

Secrets:ASHBY_API_KEY

Output

Type:json— Response from the API endpoint 'locationupdateworkplacetype'.
Last updated on