Ashby
Manage candidates, jobs, and applications in Ashby
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).
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
candidateId | string | Yes | No description |
tagId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the tag was successfully added |
Moves an application to a different interview stage. Requires an archive reason when moving to an Archived stage.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
applicationId | string | Yes | No description |
interviewStageId | string | Yes | No description |
archiveReasonId | string | No | Archive reason UUID. Required when moving to an Archived stage, ignored otherwise |
| Parameter | Type | Description |
|---|
applicationId | string | Application UUID |
stageId | string | New interview stage UUID |
Creates a new application for a candidate on a job. Optionally specify interview plan, stage, source, and credited user.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
candidateId | string | Yes | No description |
jobId | string | Yes | No description |
interviewPlanId | string | No | No description |
interviewStageId | string | No | UUID of the interview stage to place the application in (defaults to first Lead stage) |
sourceId | string | No | No description |
creditedToUserId | string | No | No description |
createdAt | string | No | No description |
| Parameter | Type | Description |
|---|
applicationId | string | Created application UUID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | Yes | No description |
email | string | Yes | No description |
phoneNumber | string | No | No description |
linkedInUrl | string | No | No description |
githubUrl | string | No | No description |
sourceId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Created candidate UUID |
name | string | Full name |
primaryEmailAddress | object | Primary email contact info |
↳ value | string | Email address |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary email |
primaryPhoneNumber | object | Primary phone contact info |
↳ value | string | Phone number |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary phone |
createdAt | string | ISO 8601 creation timestamp |
Creates a note on a candidate in Ashby. Supports plain text and HTML content (bold, italic, underline, links, lists, code).
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
candidateId | string | Yes | No description |
note | string | Yes | The note content. If noteType is text/html, supports: <b>, <i>, <u>, <a>, <ul>, <ol>, <li>, <code>, <pre> |
noteType | string | No | No description |
sendNotifications | boolean | No | No description |
| Parameter | Type | Description |
|---|
noteId | string | Created note UUID |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
applicationId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Application UUID |
status | string | Application status (Active, Hired, Archived, Lead) |
candidate | object | Associated candidate |
↳ id | string | Candidate UUID |
↳ name | string | Candidate name |
job | object | Associated job |
↳ id | string | Job UUID |
↳ title | string | Job title |
currentInterviewStage | object | Current interview stage |
↳ id | string | Stage UUID |
↳ title | string | Stage title |
↳ type | string | Stage type |
source | object | Application source |
↳ id | string | Source UUID |
↳ title | string | Source title |
archiveReason | object | Reason for archival |
↳ id | string | Reason UUID |
↳ text | string | Reason text |
↳ reasonType | string | Reason type |
archivedAt | string | ISO 8601 archive timestamp |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
candidateId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Candidate UUID |
name | string | Full name |
primaryEmailAddress | object | Primary email contact info |
↳ value | string | Email address |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary email |
primaryPhoneNumber | object | Primary phone contact info |
↳ value | string | Phone number |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary phone |
profileUrl | string | URL to the candidate Ashby profile |
position | string | Current position or title |
company | string | Current company |
linkedInUrl | string | LinkedIn profile URL |
githubUrl | string | GitHub profile URL |
tags | array | Tags applied to the candidate |
↳ id | string | Tag UUID |
↳ title | string | Tag title |
applicationIds | array | IDs of associated applications |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
jobId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Job UUID |
title | string | Job title |
status | string | Job status (Open, Closed, Draft, Archived) |
employmentType | string | Employment type (FullTime, PartTime, Intern, Contract, Temporary) |
departmentId | string | Department UUID |
locationId | string | Location UUID |
descriptionPlain | string | Job description in plain text |
isArchived | boolean | Whether the job is archived |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
jobPostingId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Job posting UUID |
title | string | Job posting title |
jobId | string | Associated job UUID |
locationName | string | Location name |
departmentName | string | Department name |
employmentType | string | Employment type (e.g. FullTime, PartTime, Contract) |
descriptionPlain | string | Job posting description in plain text |
isListed | boolean | Whether the posting is publicly listed |
publishedDate | string | ISO 8601 published date |
externalLink | string | External link to the job posting |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
offerId | string | Yes | No description |
| Parameter | Type | Description |
|---|
id | string | Offer UUID |
offerStatus | string | Offer status (e.g. WaitingOnCandidateResponse, CandidateAccepted) |
acceptanceStatus | string | Acceptance status (e.g. Accepted, Declined, Pending) |
applicationId | string | Associated application UUID |
startDate | string | Offer start date |
salary | object | Salary details |
↳ currencyCode | string | ISO 4217 currency code |
↳ value | number | Salary amount |
openingId | string | Associated opening UUID |
createdAt | string | ISO 8601 creation timestamp (from latest version) |
Lists all applications in an Ashby organization with pagination and optional filters for status, job, candidate, and creation date.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
cursor | string | No | No description |
perPage | number | No | No description |
status | string | No | No description |
jobId | string | No | No description |
candidateId | string | No | No description |
createdAfter | string | No | Filter to applications created after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z) |
| Parameter | Type | Description |
|---|
applications | array | List of applications |
↳ id | string | Application UUID |
↳ status | string | Application status (Active, Hired, Archived, Lead) |
↳ candidate | object | Associated candidate |
↳ id | string | Candidate UUID |
↳ name | string | Candidate name |
↳ job | object | Associated job |
↳ id | string | Job UUID |
↳ title | string | Job title |
↳ currentInterviewStage | object | Current interview stage |
↳ id | string | Stage UUID |
↳ title | string | Stage title |
↳ type | string | Stage type |
↳ source | object | Application source |
↳ id | string | Source UUID |
↳ title | string | Source title |
↳ createdAt | string | ISO 8601 creation timestamp |
↳ updatedAt | string | ISO 8601 last update timestamp |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
archiveReasons | array | List of archive reasons |
↳ id | string | Archive reason UUID |
↳ text | string | Archive reason text |
↳ reasonType | string | Reason type |
↳ isArchived | boolean | Whether the reason is archived |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
tags | array | List of candidate tags |
↳ id | string | Tag UUID |
↳ title | string | Tag title |
↳ isArchived | boolean | Whether the tag is archived |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
cursor | string | No | No description |
perPage | number | No | No description |
| Parameter | Type | Description |
|---|
candidates | array | List of candidates |
↳ id | string | Candidate UUID |
↳ name | string | Full name |
↳ primaryEmailAddress | object | Primary email contact info |
↳ value | string | Email address |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary email |
↳ primaryPhoneNumber | object | Primary phone contact info |
↳ value | string | Phone number |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary phone |
↳ createdAt | string | ISO 8601 creation timestamp |
↳ updatedAt | string | ISO 8601 last update timestamp |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
customFields | array | List of custom field definitions |
↳ id | string | Custom field UUID |
↳ title | string | Custom field title |
↳ fieldType | string | Field type (e.g. String, Number, Boolean) |
↳ objectType | string | Object type the field applies to (e.g. Candidate, Application, Job) |
↳ isArchived | boolean | Whether the custom field is archived |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
departments | array | List of departments |
↳ id | string | Department UUID |
↳ name | string | Department name |
↳ isArchived | boolean | Whether the department is archived |
↳ parentId | string | Parent department UUID |
Lists interview schedules in Ashby, optionally filtered by application or interview stage.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
applicationId | string | No | No description |
interviewStageId | string | No | No description |
cursor | string | No | No description |
perPage | number | No | No description |
| Parameter | Type | Description |
|---|
interviewSchedules | array | List of interview schedules |
↳ id | string | Interview schedule UUID |
↳ applicationId | string | Associated application UUID |
↳ interviewStageId | string | Interview stage UUID |
↳ status | string | Schedule status |
↳ createdAt | string | ISO 8601 creation timestamp |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
jobPostings | array | List of job postings |
↳ id | string | Job posting UUID |
↳ title | string | Job posting title |
↳ jobId | string | Associated job UUID |
↳ locationName | string | Location name |
↳ departmentName | string | Department name |
↳ employmentType | string | Employment type (e.g. FullTime, PartTime, Contract) |
↳ isListed | boolean | Whether the posting is publicly listed |
↳ publishedDate | string | ISO 8601 published date |
Lists all jobs in an Ashby organization. By default returns Open, Closed, and Archived jobs. Specify status to filter.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
cursor | string | No | No description |
perPage | number | No | No description |
status | string | No | No description |
| Parameter | Type | Description |
|---|
jobs | array | List of jobs |
↳ id | string | Job UUID |
↳ title | string | Job title |
↳ status | string | Job status (Open, Closed, Archived, Draft) |
↳ employmentType | string | Employment type (FullTime, PartTime, Intern, Contract, Temporary) |
↳ departmentId | string | Department UUID |
↳ locationId | string | Location UUID |
↳ createdAt | string | ISO 8601 creation timestamp |
↳ updatedAt | string | ISO 8601 last update timestamp |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
locations | array | List of locations |
↳ id | string | Location UUID |
↳ name | string | Location name |
↳ isArchived | boolean | Whether the location is archived |
↳ isRemote | boolean | Whether this is a remote location |
↳ address | object | Location address |
↳ city | string | City |
↳ region | string | State or region |
↳ country | string | Country |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
candidateId | string | Yes | No description |
cursor | string | No | No description |
perPage | number | No | No description |
| Parameter | Type | Description |
|---|
notes | array | List of notes on the candidate |
↳ id | string | Note UUID |
↳ content | string | Note content |
↳ author | object | Note author |
↳ id | string | Author user UUID |
↳ firstName | string | First name |
↳ lastName | string | Last name |
↳ email | string | Email address |
↳ createdAt | string | ISO 8601 creation timestamp |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
cursor | string | No | No description |
perPage | number | No | No description |
| Parameter | Type | Description |
|---|
offers | array | List of offers |
↳ id | string | Offer UUID |
↳ offerStatus | string | Offer status |
↳ acceptanceStatus | string | Acceptance status |
↳ applicationId | string | Associated application UUID |
↳ startDate | string | Offer start date |
↳ salary | object | Salary details |
↳ currencyCode | string | ISO 4217 currency code |
↳ value | number | Salary amount |
↳ openingId | string | Associated opening UUID |
↳ createdAt | string | ISO 8601 creation timestamp |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
cursor | string | No | No description |
perPage | number | No | No description |
| Parameter | Type | Description |
|---|
openings | array | List of openings |
↳ id | string | Opening UUID |
↳ openingState | string | Opening state (Approved, Closed, Draft, Filled, Open) |
↳ isArchived | boolean | Whether the opening is archived |
↳ openedAt | string | ISO 8601 opened timestamp |
↳ closedAt | string | ISO 8601 closed timestamp |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
sources | array | List of sources |
↳ id | string | Source UUID |
↳ title | string | Source title |
↳ isArchived | boolean | Whether the source is archived |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
cursor | string | No | No description |
perPage | number | No | No description |
| Parameter | Type | Description |
|---|
users | array | List of users |
↳ id | string | User UUID |
↳ firstName | string | First name |
↳ lastName | string | Last name |
↳ email | string | Email address |
↳ isEnabled | boolean | Whether the user account is enabled |
↳ globalRole | string | User role (Organization Admin, Elevated Access, Limited Access, External Recruiter) |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
candidateId | string | Yes | No description |
tagId | string | Yes | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the tag was successfully removed |
Searches for candidates by name and/or email with AND logic. Results are limited to 100 matches. Use candidate.list for full pagination.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
name | string | No | No description |
email | string | No | No description |
| Parameter | Type | Description |
|---|
candidates | array | Matching candidates (max 100 results) |
↳ id | string | Candidate UUID |
↳ name | string | Full name |
↳ primaryEmailAddress | object | Primary email contact info |
↳ value | string | Email address |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary email |
↳ primaryPhoneNumber | object | Primary phone contact info |
↳ value | string | Phone number |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary phone |
↳ createdAt | string | ISO 8601 creation timestamp |
↳ updatedAt | string | ISO 8601 last update timestamp |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
candidateId | string | Yes | No description |
name | string | No | No description |
email | string | No | No description |
phoneNumber | string | No | No description |
linkedInUrl | string | No | No description |
githubUrl | string | No | No description |
websiteUrl | string | No | No description |
sourceId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Candidate UUID |
name | string | Full name |
primaryEmailAddress | object | Primary email contact info |
↳ value | string | Email address |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary email |
primaryPhoneNumber | object | Primary phone contact info |
↳ value | string | Phone number |
↳ type | string | Contact type (Personal, Work, Other) |
↳ isPrimary | boolean | Whether this is the primary phone |
profileUrl | string | URL to the candidate Ashby profile |
position | string | Current position or title |
company | string | Current company |
linkedInUrl | string | linkedInUrl output from the tool |
githubUrl | string | githubUrl output from the tool |
tags | array | Tags applied to the candidate |
↳ id | string | Tag UUID |
↳ title | string | Tag title |
applicationIds | array | IDs of associated applications |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |