Ashby

Manage candidates, jobs, and applications in Ashby

Ashby is an all-in-one recruiting platform that combines an applicant tracking system (ATS), CRM, scheduling, and analytics to help teams hire more effectively.

With Ashby, you can:

  • List and search candidates: Browse your full candidate pipeline or search by name and email to quickly find specific people
  • Create candidates: Add new candidates to your Ashby organization with contact details
  • View candidate details: Retrieve full candidate profiles including tags, email, phone, and timestamps
  • Add notes to candidates: Attach notes to candidate records to capture feedback, context, or follow-up items
  • List and view jobs: Browse all open, closed, and archived job postings with location and department info
  • List applications: View all applications across your organization with candidate and job details, status tracking, and pagination

The Ashby block also supports webhook triggers that automatically start workflows in response to Ashby events. Available triggers include Application Submitted, Candidate Stage Change, Candidate Hired, Candidate Deleted, Job Created, and Offer Created. Webhooks are fully managed — Sim automatically creates the webhook in Ashby when you save the trigger and deletes it when you remove it, so there's no manual webhook configuration needed. Just provide your Ashby API key (with apiKeysWrite permission) and select the event type.

In Sim, the Ashby integration enables your agents to programmatically manage your recruiting pipeline. Agents can search for candidates, create new candidate records, add notes after interviews, and monitor applications across jobs. This allows you to automate recruiting workflows like candidate intake, interview follow-ups, pipeline reporting, and cross-referencing candidates across roles.

Usage Instructions

Integrate Ashby into the workflow. Manage candidates (list, get, create, update, search, tag), applications (list, get, create, change stage), jobs (list, get), job postings (list, get), offers (list, get), notes (list, create), interviews (list), and reference data (sources, tags, archive reasons, custom fields, departments, locations, openings, users).

Tools

ashby_add_candidate_tag

Adds a tag to a candidate in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
candidateIdstringYesThe UUID of the candidate to add the tag to
tagIdstringYesThe UUID of the tag to add

Output

ParameterTypeDescription
successbooleanWhether the tag was successfully added

ashby_change_application_stage

Moves an application to a different interview stage. Requires an archive reason when moving to an Archived stage.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
applicationIdstringYesThe UUID of the application to update the stage of
interviewStageIdstringYesThe UUID of the interview stage to move the application to
archiveReasonIdstringNoArchive reason UUID. Required when moving to an Archived stage, ignored otherwise

Output

ParameterTypeDescription
applicationIdstringApplication UUID
stageIdstringNew interview stage UUID

ashby_create_application

Creates a new application for a candidate on a job. Optionally specify interview plan, stage, source, and credited user.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
candidateIdstringYesThe UUID of the candidate to consider for the job
jobIdstringYesThe UUID of the job to consider the candidate for
interviewPlanIdstringNoUUID of the interview plan to use (defaults to the job default plan)
interviewStageIdstringNoUUID of the interview stage to place the application in (defaults to first Lead stage)
sourceIdstringNoUUID of the source to set on the application
creditedToUserIdstringNoUUID of the user the application is credited to
createdAtstringNoISO 8601 timestamp to set as the application creation date (defaults to now)

Output

ParameterTypeDescription
applicationIdstringCreated application UUID

ashby_create_candidate

Creates a new candidate record in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
namestringYesThe candidate full name
emailstringYesPrimary email address for the candidate
phoneNumberstringNoPrimary phone number for the candidate
linkedInUrlstringNoLinkedIn profile URL
githubUrlstringNoGitHub profile URL
sourceIdstringNoUUID of the source to attribute the candidate to

Output

ParameterTypeDescription
idstringCreated candidate UUID
namestringFull name
primaryEmailAddressobjectPrimary email contact info
valuestringEmail address
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary email
primaryPhoneNumberobjectPrimary phone contact info
valuestringPhone number
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary phone
createdAtstringISO 8601 creation timestamp

ashby_create_note

Creates a note on a candidate in Ashby. Supports plain text and HTML content (bold, italic, underline, links, lists, code).

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
candidateIdstringYesThe UUID of the candidate to add the note to
notestringYesThe note content. If noteType is text/html, supports: <b>, <i>, <u>, <a>, <ul>, <ol>, <li>, <code>, <pre>
noteTypestringNoContent type of the note: text/plain (default) or text/html
sendNotificationsbooleanNoWhether to send notifications to subscribed users (default false)

Output

ParameterTypeDescription
noteIdstringCreated note UUID

ashby_get_application

Retrieves full details about a single application by its ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
applicationIdstringYesThe UUID of the application to fetch

Output

ParameterTypeDescription
idstringApplication UUID
statusstringApplication status (Active, Hired, Archived, Lead)
candidateobjectAssociated candidate
idstringCandidate UUID
namestringCandidate name
jobobjectAssociated job
idstringJob UUID
titlestringJob title
currentInterviewStageobjectCurrent interview stage
idstringStage UUID
titlestringStage title
typestringStage type
sourceobjectApplication source
idstringSource UUID
titlestringSource title
archiveReasonobjectReason for archival
idstringReason UUID
textstringReason text
reasonTypestringReason type
archivedAtstringISO 8601 archive timestamp
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

ashby_get_candidate

Retrieves full details about a single candidate by their ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
candidateIdstringYesThe UUID of the candidate to fetch

Output

ParameterTypeDescription
idstringCandidate UUID
namestringFull name
primaryEmailAddressobjectPrimary email contact info
valuestringEmail address
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary email
primaryPhoneNumberobjectPrimary phone contact info
valuestringPhone number
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary phone
profileUrlstringURL to the candidate Ashby profile
positionstringCurrent position or title
companystringCurrent company
linkedInUrlstringLinkedIn profile URL
githubUrlstringGitHub profile URL
tagsarrayTags applied to the candidate
idstringTag UUID
titlestringTag title
applicationIdsarrayIDs of associated applications
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

ashby_get_job

Retrieves full details about a single job by its ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
jobIdstringYesThe UUID of the job to fetch

Output

ParameterTypeDescription
idstringJob UUID
titlestringJob title
statusstringJob status (Open, Closed, Draft, Archived)
employmentTypestringEmployment type (FullTime, PartTime, Intern, Contract, Temporary)
departmentIdstringDepartment UUID
locationIdstringLocation UUID
descriptionPlainstringJob description in plain text
isArchivedbooleanWhether the job is archived
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

ashby_get_job_posting

Retrieves full details about a single job posting by its ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
jobPostingIdstringYesThe UUID of the job posting to fetch

Output

ParameterTypeDescription
idstringJob posting UUID
titlestringJob posting title
jobIdstringAssociated job UUID
locationNamestringLocation name
departmentNamestringDepartment name
employmentTypestringEmployment type (e.g. FullTime, PartTime, Contract)
descriptionPlainstringJob posting description in plain text
isListedbooleanWhether the posting is publicly listed
publishedDatestringISO 8601 published date
externalLinkstringExternal link to the job posting

ashby_get_offer

Retrieves full details about a single offer by its ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
offerIdstringYesThe UUID of the offer to fetch

Output

ParameterTypeDescription
idstringOffer UUID
offerStatusstringOffer status (e.g. WaitingOnCandidateResponse, CandidateAccepted)
acceptanceStatusstringAcceptance status (e.g. Accepted, Declined, Pending)
applicationIdstringAssociated application UUID
startDatestringOffer start date
salaryobjectSalary details
currencyCodestringISO 4217 currency code
valuenumberSalary amount
openingIdstringAssociated opening UUID
createdAtstringISO 8601 creation timestamp (from latest version)

ashby_list_applications

Lists all applications in an Ashby organization with pagination and optional filters for status, job, candidate, and creation date.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
cursorstringNoOpaque pagination cursor from a previous response nextCursor value
perPagenumberNoNumber of results per page (default 100)
statusstringNoFilter by application status: Active, Hired, Archived, or Lead
jobIdstringNoFilter applications by a specific job UUID
candidateIdstringNoFilter applications by a specific candidate UUID
createdAfterstringNoFilter to applications created after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z)

Output

ParameterTypeDescription
applicationsarrayList of applications
idstringApplication UUID
statusstringApplication status (Active, Hired, Archived, Lead)
candidateobjectAssociated candidate
idstringCandidate UUID
namestringCandidate name
jobobjectAssociated job
idstringJob UUID
titlestringJob title
currentInterviewStageobjectCurrent interview stage
idstringStage UUID
titlestringStage title
typestringStage type
sourceobjectApplication source
idstringSource UUID
titlestringSource title
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp
moreDataAvailablebooleanWhether more pages of results exist
nextCursorstringOpaque cursor for fetching the next page

ashby_list_archive_reasons

Lists all archive reasons configured in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key

Output

ParameterTypeDescription
archiveReasonsarrayList of archive reasons
idstringArchive reason UUID
textstringArchive reason text
reasonTypestringReason type
isArchivedbooleanWhether the reason is archived

ashby_list_candidate_tags

Lists all candidate tags configured in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key

Output

ParameterTypeDescription
tagsarrayList of candidate tags
idstringTag UUID
titlestringTag title
isArchivedbooleanWhether the tag is archived

ashby_list_candidates

Lists all candidates in an Ashby organization with cursor-based pagination.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
cursorstringNoOpaque pagination cursor from a previous response nextCursor value
perPagenumberNoNumber of results per page (default 100)

Output

ParameterTypeDescription
candidatesarrayList of candidates
idstringCandidate UUID
namestringFull name
primaryEmailAddressobjectPrimary email contact info
valuestringEmail address
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary email
primaryPhoneNumberobjectPrimary phone contact info
valuestringPhone number
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary phone
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp
moreDataAvailablebooleanWhether more pages of results exist
nextCursorstringOpaque cursor for fetching the next page

ashby_list_custom_fields

Lists all custom field definitions configured in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key

Output

ParameterTypeDescription
customFieldsarrayList of custom field definitions
idstringCustom field UUID
titlestringCustom field title
fieldTypestringField type (e.g. String, Number, Boolean)
objectTypestringObject type the field applies to (e.g. Candidate, Application, Job)
isArchivedbooleanWhether the custom field is archived

ashby_list_departments

Lists all departments in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key

Output

ParameterTypeDescription
departmentsarrayList of departments
idstringDepartment UUID
namestringDepartment name
isArchivedbooleanWhether the department is archived
parentIdstringParent department UUID

ashby_list_interviews

Lists interview schedules in Ashby, optionally filtered by application or interview stage.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
applicationIdstringNoThe UUID of the application to list interview schedules for
interviewStageIdstringNoThe UUID of the interview stage to list interview schedules for
cursorstringNoOpaque pagination cursor from a previous response nextCursor value
perPagenumberNoNumber of results per page (default 100)

Output

ParameterTypeDescription
interviewSchedulesarrayList of interview schedules
idstringInterview schedule UUID
applicationIdstringAssociated application UUID
interviewStageIdstringInterview stage UUID
statusstringSchedule status
createdAtstringISO 8601 creation timestamp
moreDataAvailablebooleanWhether more pages of results exist
nextCursorstringOpaque cursor for fetching the next page

ashby_list_job_postings

Lists all job postings in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key

Output

ParameterTypeDescription
jobPostingsarrayList of job postings
idstringJob posting UUID
titlestringJob posting title
jobIdstringAssociated job UUID
locationNamestringLocation name
departmentNamestringDepartment name
employmentTypestringEmployment type (e.g. FullTime, PartTime, Contract)
isListedbooleanWhether the posting is publicly listed
publishedDatestringISO 8601 published date

ashby_list_jobs

Lists all jobs in an Ashby organization. By default returns Open, Closed, and Archived jobs. Specify status to filter.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
cursorstringNoOpaque pagination cursor from a previous response nextCursor value
perPagenumberNoNumber of results per page (default 100)
statusstringNoFilter by job status: Open, Closed, Archived, or Draft

Output

ParameterTypeDescription
jobsarrayList of jobs
idstringJob UUID
titlestringJob title
statusstringJob status (Open, Closed, Archived, Draft)
employmentTypestringEmployment type (FullTime, PartTime, Intern, Contract, Temporary)
departmentIdstringDepartment UUID
locationIdstringLocation UUID
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp
moreDataAvailablebooleanWhether more pages of results exist
nextCursorstringOpaque cursor for fetching the next page

ashby_list_locations

Lists all locations configured in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key

Output

ParameterTypeDescription
locationsarrayList of locations
idstringLocation UUID
namestringLocation name
isArchivedbooleanWhether the location is archived
isRemotebooleanWhether this is a remote location
addressobjectLocation address
citystringCity
regionstringState or region
countrystringCountry

ashby_list_notes

Lists all notes on a candidate with pagination support.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
candidateIdstringYesThe UUID of the candidate to list notes for
cursorstringNoOpaque pagination cursor from a previous response nextCursor value
perPagenumberNoNumber of results per page

Output

ParameterTypeDescription
notesarrayList of notes on the candidate
idstringNote UUID
contentstringNote content
authorobjectNote author
idstringAuthor user UUID
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
createdAtstringISO 8601 creation timestamp
moreDataAvailablebooleanWhether more pages of results exist
nextCursorstringOpaque cursor for fetching the next page

ashby_list_offers

Lists all offers with their latest version in an Ashby organization.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
cursorstringNoOpaque pagination cursor from a previous response nextCursor value
perPagenumberNoNumber of results per page

Output

ParameterTypeDescription
offersarrayList of offers
idstringOffer UUID
offerStatusstringOffer status
acceptanceStatusstringAcceptance status
applicationIdstringAssociated application UUID
startDatestringOffer start date
salaryobjectSalary details
currencyCodestringISO 4217 currency code
valuenumberSalary amount
openingIdstringAssociated opening UUID
createdAtstringISO 8601 creation timestamp
moreDataAvailablebooleanWhether more pages of results exist
nextCursorstringOpaque cursor for fetching the next page

ashby_list_openings

Lists all openings in Ashby with pagination.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
cursorstringNoOpaque pagination cursor from a previous response nextCursor value
perPagenumberNoNumber of results per page (default 100)

Output

ParameterTypeDescription
openingsarrayList of openings
idstringOpening UUID
openingStatestringOpening state (Approved, Closed, Draft, Filled, Open)
isArchivedbooleanWhether the opening is archived
openedAtstringISO 8601 opened timestamp
closedAtstringISO 8601 closed timestamp
moreDataAvailablebooleanWhether more pages of results exist
nextCursorstringOpaque cursor for fetching the next page

ashby_list_sources

Lists all candidate sources configured in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key

Output

ParameterTypeDescription
sourcesarrayList of sources
idstringSource UUID
titlestringSource title
isArchivedbooleanWhether the source is archived

ashby_list_users

Lists all users in Ashby with pagination.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
cursorstringNoOpaque pagination cursor from a previous response nextCursor value
perPagenumberNoNumber of results per page (default 100)

Output

ParameterTypeDescription
usersarrayList of users
idstringUser UUID
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
isEnabledbooleanWhether the user account is enabled
globalRolestringUser role (Organization Admin, Elevated Access, Limited Access, External Recruiter)
moreDataAvailablebooleanWhether more pages of results exist
nextCursorstringOpaque cursor for fetching the next page

ashby_remove_candidate_tag

Removes a tag from a candidate in Ashby.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
candidateIdstringYesThe UUID of the candidate to remove the tag from
tagIdstringYesThe UUID of the tag to remove

Output

ParameterTypeDescription
successbooleanWhether the tag was successfully removed

ashby_search_candidates

Searches for candidates by name and/or email with AND logic. Results are limited to 100 matches. Use candidate.list for full pagination.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
namestringNoCandidate name to search for (combined with email using AND logic)
emailstringNoCandidate email to search for (combined with name using AND logic)

Output

ParameterTypeDescription
candidatesarrayMatching candidates (max 100 results)
idstringCandidate UUID
namestringFull name
primaryEmailAddressobjectPrimary email contact info
valuestringEmail address
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary email
primaryPhoneNumberobjectPrimary phone contact info
valuestringPhone number
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary phone
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

ashby_update_candidate

Updates an existing candidate record in Ashby. Only provided fields are changed.

Input

ParameterTypeRequiredDescription
apiKeystringYesAshby API Key
candidateIdstringYesThe UUID of the candidate to update
namestringNoUpdated full name
emailstringNoUpdated primary email address
phoneNumberstringNoUpdated primary phone number
linkedInUrlstringNoLinkedIn profile URL
githubUrlstringNoGitHub profile URL
websiteUrlstringNoPersonal website URL
sourceIdstringNoUUID of the source to attribute the candidate to

Output

ParameterTypeDescription
idstringCandidate UUID
namestringFull name
primaryEmailAddressobjectPrimary email contact info
valuestringEmail address
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary email
primaryPhoneNumberobjectPrimary phone contact info
valuestringPhone number
typestringContact type (Personal, Work, Other)
isPrimarybooleanWhether this is the primary phone
profileUrlstringURL to the candidate Ashby profile
positionstringCurrent position or title
companystringCurrent company
linkedInUrlstringLinkedIn profile URL
githubUrlstringGitHub profile URL
tagsarrayTags applied to the candidate
idstringTag UUID
titlestringTag title
applicationIdsarrayIDs of associated applications
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last update timestamp

On this page