AACFlow

Ashby

Manage candidates, jobs, and applications in Ashby

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
candidateIdstringYesNo description
tagIdstringYesNo description

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
apiKeystringYesNo description
applicationIdstringYesNo description
interviewStageIdstringYesNo description
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
apiKeystringYesNo description
candidateIdstringYesNo description
jobIdstringYesNo description
interviewPlanIdstringNoNo description
interviewStageIdstringNoUUID of the interview stage to place the application in (defaults to first Lead stage)
sourceIdstringNoNo description
creditedToUserIdstringNoNo description
createdAtstringNoNo description

Output

ParameterTypeDescription
applicationIdstringCreated application UUID

ashby_create_candidate

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
namestringYesNo description
emailstringYesNo description
phoneNumberstringNoNo description
linkedInUrlstringNoNo description
githubUrlstringNoNo description
sourceIdstringNoNo description

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
apiKeystringYesNo description
candidateIdstringYesNo description
notestringYesThe note content. If noteType is text/html, supports: <b>, <i>, <u>, <a>, <ul>, <ol>, <li>, <code>, <pre>
noteTypestringNoNo description
sendNotificationsbooleanNoNo description

Output

ParameterTypeDescription
noteIdstringCreated note UUID

ashby_get_application

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
applicationIdstringYesNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
candidateIdstringYesNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
jobIdstringYesNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
jobPostingIdstringYesNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
offerIdstringYesNo description

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
apiKeystringYesNo description
cursorstringNoNo description
perPagenumberNoNo description
statusstringNoNo description
jobIdstringNoNo description
candidateIdstringNoNo description
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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description

Output

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

ashby_list_candidate_tags

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description

Output

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

ashby_list_candidates

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
cursorstringNoNo description
perPagenumberNoNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description

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
apiKeystringYesNo description
applicationIdstringNoNo description
interviewStageIdstringNoNo description
cursorstringNoNo description
perPagenumberNoNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description

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
apiKeystringYesNo description
cursorstringNoNo description
perPagenumberNoNo description
statusstringNoNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
candidateIdstringYesNo description
cursorstringNoNo description
perPagenumberNoNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
cursorstringNoNo description
perPagenumberNoNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
cursorstringNoNo description
perPagenumberNoNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description

Output

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

ashby_list_users

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
cursorstringNoNo description
perPagenumberNoNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
candidateIdstringYesNo description
tagIdstringYesNo description

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
apiKeystringYesNo description
namestringNoNo description
emailstringNoNo description

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

Input

ParameterTypeRequiredDescription
apiKeystringYesNo description
candidateIdstringYesNo description
namestringNoNo description
emailstringNoNo description
phoneNumberstringNoNo description
linkedInUrlstringNoNo description
githubUrlstringNoNo description
websiteUrlstringNoNo description
sourceIdstringNoNo description

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
linkedInUrlstringlinkedInUrl output from the tool
githubUrlstringgithubUrl output from the tool
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

Start building today
Trusted by over 100,000 builders.
The SaaS platform to build AI agents and run your agentic workforce.
Get started