Ashby

App · 25 actions

Run your Ashby hiring pipeline: find, add, update and tag candidates, add notes and resumes, put them forward for jobs, move or archive applications, read interview feedback, schedules and offers, and manage jobs and custom fields.

Actions

ActionWhat it does
Add candidate to jobConsider a candidate for a job.
Add note to candidateWrite a note on a candidate's profile, as the API key's user.
Add tag to candidateTag a candidate.
Anonymize candidatePermanently erase a candidate's personal details, for a request to delete their data.
Archive applicationArchive (reject) an application with a reason, and optionally send the candidate one of your email templates.
Create candidateAdd a candidate to Ashby.
Create jobCreate a job as a draft.
Find candidatesFind candidates by email address, name, or both.
Get applicationGet an application: the candidate, the job, its stage and status, its source and its hiring team.
Get candidateGet a candidate's profile: contact details, links, tags, source, custom fields and the IDs of their applications.
Get jobGet a job: its status, location, department, hiring team and interview plans.
Get offerGet an offer at its latest version: status, the candidate's answer, start date, salary and approval.
List applicationsList applications, optionally for one job, with one status, or made in a date range.
List candidate notesList the notes on a candidate's profile, newest first.
List interview feedbackList the scorecards and feedback interviewers submitted on an application, each question with its answer.
List interview schedulesList scheduled interviews, with their times, interviewers and video links, for one application or the whole organization.
List jobsList jobs, optionally only those with certain statuses.
List offersList offers with their status, start date and salary, optionally for one application or with the candidate's answer.
Move application to another jobTransfer an application to a different job, at a stage of that job's interview plan.
Move application to stageMove an application to another stage of its interview plan, such as Onsite or Offer.
Remove tag from candidateTake a tag off a candidate.
Set custom fieldSet one of your custom fields on a candidate, application, job or opening.
Set job statusOpen, close or archive a job, or put it back to draft.
Update candidateChange a candidate's details.
Upload candidate resumeAttach a resume to a candidate, such as one from an email.

Add candidate to job

Consider a candidate for a job. They start at the stage you pick, or the plan's first lead stage.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.
Jobjob_idtextRequired
The job. Pick one, or give its ID from an earlier step.
Stagestagetext
Where they start in the job's interview plan. Leave empty for the first lead stage.
Sourcesource_idtext
Where the candidate came from, such as Referral or LinkedIn.
Credited tocredited_to_user_idtext
The teammate who gets credit for bringing them in.

Outputs

applicationobject
The application
Example output
{
  "application": {
    "archive_reason": "",
    "archive_reason_id": "",
    "archived_at": "",
    "candidate_email": "adam.hart@example.com",
    "candidate_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "candidate_name": "Adam Hart",
    "candidate_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [],
    "hiring_team": [
      {
        "email": "jane.smith@example.com",
        "name": "Jane Smith",
        "role": "Recruiter",
        "user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d"
      }
    ],
    "id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
    "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
    "job_title": "Product Designer",
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "stage": "Phone Screen",
    "stage_id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
    "stage_type": "Active",
    "status": "Active",
    "updated_at": "2026-10-16T10:30:00.000Z"
  }
}

Add note to candidate

Write a note on a candidate's profile, as the API key's user.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.
NotenotetextRequired
What the note says.
Privateprivatetrue/false
Show it only to people allowed to see private notes. The API key needs Ashby's private fields permission for this.
Notify followersnotify_followerstrue/false
Tell the teammates who follow this candidate in Ashby. Defaults to yes for an update and no for a note.

Outputs

noteobject
The note
Example output
{
  "note": {
    "author": "Jane Smith",
    "author_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "content": "Strong portfolio; keen to talk about the design system.",
    "created_at": "2026-10-15T10:30:00.000Z",
    "id": "5fa61e0b-3c4d-4e5f-9a0b-1c2d3e4f5a6b",
    "is_private": false
  }
}

Add tag to candidate

Tag a candidate. Pick a tag, or type a name: a tag Ashby doesn't have yet is created.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.
TagtagtextRequired
The tag. Pick one, or type a name.

Outputs

candidateobject
The candidate, with its tags
tag_idtext
The tag's ID
Example output
{
  "candidate": {
    "application_ids": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "company": "Acme",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [
      {
        "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
        "title": "Preferred Team",
        "value": "Design"
      }
    ],
    "email": "adam.hart@example.com",
    "emails": [
      "adam.hart@example.com"
    ],
    "fraud_status": "",
    "github_url": "",
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "linkedin_url": "https://linkedin.com/in/adamhart",
    "location": "San Francisco, California, United States",
    "name": "Adam Hart",
    "phone": "+1 415 555 0100",
    "phones": [
      "+1 415 555 0100"
    ],
    "position": "Product Designer",
    "profile_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "resume_file_name": "adam-hart-resume.pdf",
    "school": "",
    "social_links": [
      {
        "type": "LinkedIn",
        "url": "https://linkedin.com/in/adamhart"
      }
    ],
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "tags": [
      {
        "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
        "title": "Strong candidate"
      }
    ],
    "timezone": "America/Los_Angeles",
    "updated_at": "2026-10-16T10:30:00.000Z",
    "website_url": ""
  },
  "tag_id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d"
}

Anonymize candidate

Permanently erase a candidate's personal details, for a request to delete their data. This can't be undone.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "application_ids": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "company": "Acme",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [
      {
        "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
        "title": "Preferred Team",
        "value": "Design"
      }
    ],
    "email": "",
    "emails": [],
    "fraud_status": "",
    "github_url": "",
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "linkedin_url": "https://linkedin.com/in/adamhart",
    "location": "San Francisco, California, United States",
    "name": "Anonymized candidate",
    "phone": "",
    "phones": [],
    "position": "Product Designer",
    "profile_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "resume_file_name": "adam-hart-resume.pdf",
    "school": "",
    "social_links": [
      {
        "type": "LinkedIn",
        "url": "https://linkedin.com/in/adamhart"
      }
    ],
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "tags": [
      {
        "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
        "title": "Strong candidate"
      }
    ],
    "timezone": "America/Los_Angeles",
    "updated_at": "2026-10-16T10:30:00.000Z",
    "website_url": ""
  }
}

Archive application

Archive (reject) an application with a reason, and optionally send the candidate one of your email templates.

Inputs

Applicationapplication_idtextRequired
The application's ID, from 'List applications', a trigger or an earlier step.
Reasonarchive_reason_idtextRequired
Why the application is archived.
Email the candidateemail_template_idtext
An email template to send them. Leave empty to send nothing.
Send the email atsend_email_atdate and time
When to send it. Leave empty for Ashby's default, the next morning; a time already past sends it at once.

Outputs

applicationobject
The application
Example output
{
  "application": {
    "archive_reason": "Not a fit",
    "archive_reason_id": "7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f",
    "archived_at": "2026-10-17T09:00:00.000Z",
    "candidate_email": "adam.hart@example.com",
    "candidate_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "candidate_name": "Adam Hart",
    "candidate_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [],
    "hiring_team": [
      {
        "email": "jane.smith@example.com",
        "name": "Jane Smith",
        "role": "Recruiter",
        "user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d"
      }
    ],
    "id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
    "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
    "job_title": "Product Designer",
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "stage": "Archived",
    "stage_id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
    "stage_type": "Archived",
    "status": "Archived",
    "updated_at": "2026-10-16T10:30:00.000Z"
  }
}

Create candidate

Add a candidate to Ashby. If someone with the same email is already there, that candidate is returned instead of a duplicate ('created' is false). To consider them for a job, follow with 'Add candidate to job'.

Inputs

NamenametextRequired
Their first and last name.
Emailemailtext
Their personal email address.
Phonephonetext
Their phone number, ideally with the country code.
LinkedIn profilelinkedin_urltext
A link to their LinkedIn profile.
GitHub profilegithub_urltext
A link to their GitHub profile.
Websitewebsite_urltext
A link to their own website or portfolio.
Citycitytext
The city they live in.
State or regionregiontext
Their state, province or region.
Countrycountrytext
The country they live in.
Sourcesource_idtext
Where the candidate came from, such as Referral or LinkedIn.
Credited tocredited_to_user_idtext
The teammate who gets credit for bringing them in.

Outputs

candidateobject
The candidate
createdtrue/false
True for a new candidate, false when one with this email was already in Ashby
Example output
{
  "candidate": {
    "application_ids": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "company": "Acme",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [
      {
        "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
        "title": "Preferred Team",
        "value": "Design"
      }
    ],
    "email": "adam.hart@example.com",
    "emails": [
      "adam.hart@example.com"
    ],
    "fraud_status": "",
    "github_url": "",
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "linkedin_url": "https://linkedin.com/in/adamhart",
    "location": "San Francisco, California, United States",
    "name": "Adam Hart",
    "phone": "+1 415 555 0100",
    "phones": [
      "+1 415 555 0100"
    ],
    "position": "Product Designer",
    "profile_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "resume_file_name": "adam-hart-resume.pdf",
    "school": "",
    "social_links": [
      {
        "type": "LinkedIn",
        "url": "https://linkedin.com/in/adamhart"
      }
    ],
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "tags": [
      {
        "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
        "title": "Strong candidate"
      }
    ],
    "timezone": "America/Los_Angeles",
    "updated_at": "2026-10-16T10:30:00.000Z",
    "website_url": ""
  },
  "created": true
}

Create job

Create a job as a draft. Open it with 'Set job status' once it has an interview plan.

Inputs

TitletitletextRequired
The job's title.
Departmentdepartment_idtextRequired
The department or team the job is in.
Locationlocation_idtextRequired
Where the job is based.
Interview planinterview_plan_idtext
The interview plan it uses. A job needs one to open.
Employment typeemployment_typetext
Full time, part time and so on. Defaults to full time.One of: FullTime (Full time), PartTime (Part time), Contract, Temporary, Intern.

Outputs

jobobject
The job
Example output
{
  "job": {
    "closed_at": "",
    "confidential": false,
    "created_at": "2026-09-01T00:00:00.000Z",
    "custom_fields": [],
    "default_interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
    "department_id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "employment_type": "FullTime",
    "hiring_team": [],
    "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
    "interview_plan_ids": [
      "d3f4762e-1234-4abc-9876-aabbccddeeff"
    ],
    "job_posting_ids": [
      "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
    ],
    "location": "San Francisco",
    "location_id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
    "opened_at": "",
    "requisition_id": "DES-12",
    "status": "Draft",
    "title": "Product Designer",
    "updated_at": "2026-10-15T10:30:00.000Z"
  }
}

Find candidates

Find candidates by email address, name, or both. Use it to check whether someone is already in Ashby, or to get their ID.

Inputs

Emailemailtext
Their email address.
Namenametext
Their name, or part of it.
Most resultslimitnumber
How many to return, 1 to 100. Defaults to 100.From 1 to 100.

Outputs

candidateslist
The candidates found
countnumber
How many were found
has_moretrue/false
Whether more matched than were returned
Example output
{
  "candidates": [
    {
      "application_ids": [
        "f9e52a51-a075-4116-a7b8-484deba69004"
      ],
      "company": "Acme",
      "created_at": "2026-10-15T10:30:00.000Z",
      "credited_to_user": "Jane Smith",
      "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
      "custom_fields": [
        {
          "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
          "title": "Preferred Team",
          "value": "Design"
        }
      ],
      "email": "adam.hart@example.com",
      "emails": [
        "adam.hart@example.com"
      ],
      "fraud_status": "",
      "github_url": "",
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "linkedin_url": "https://linkedin.com/in/adamhart",
      "location": "San Francisco, California, United States",
      "name": "Adam Hart",
      "phone": "+1 415 555 0100",
      "phones": [
        "+1 415 555 0100"
      ],
      "position": "Product Designer",
      "profile_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "resume_file_name": "adam-hart-resume.pdf",
      "school": "",
      "social_links": [
        {
          "type": "LinkedIn",
          "url": "https://linkedin.com/in/adamhart"
        }
      ],
      "source": "Referral",
      "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
      "tags": [
        {
          "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
          "title": "Strong candidate"
        }
      ],
      "timezone": "America/Los_Angeles",
      "updated_at": "2026-10-16T10:30:00.000Z",
      "website_url": ""
    }
  ],
  "count": 1,
  "has_more": false
}

Get application

Get an application: the candidate, the job, its stage and status, its source and its hiring team.

Inputs

Applicationapplication_idtextRequired
The application's ID, from 'List applications', a trigger or an earlier step.

Outputs

applicationobject
The application
Example output
{
  "application": {
    "archive_reason": "",
    "archive_reason_id": "",
    "archived_at": "",
    "candidate_email": "adam.hart@example.com",
    "candidate_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "candidate_name": "Adam Hart",
    "candidate_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [],
    "hiring_team": [
      {
        "email": "jane.smith@example.com",
        "name": "Jane Smith",
        "role": "Recruiter",
        "user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d"
      }
    ],
    "id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
    "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
    "job_title": "Product Designer",
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "stage": "Phone Screen",
    "stage_id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
    "stage_type": "Active",
    "status": "Active",
    "updated_at": "2026-10-16T10:30:00.000Z"
  }
}

Get candidate

Get a candidate's profile: contact details, links, tags, source, custom fields and the IDs of their applications.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "application_ids": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "company": "Acme",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [
      {
        "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
        "title": "Preferred Team",
        "value": "Design"
      }
    ],
    "email": "adam.hart@example.com",
    "emails": [
      "adam.hart@example.com"
    ],
    "fraud_status": "",
    "github_url": "",
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "linkedin_url": "https://linkedin.com/in/adamhart",
    "location": "San Francisco, California, United States",
    "name": "Adam Hart",
    "phone": "+1 415 555 0100",
    "phones": [
      "+1 415 555 0100"
    ],
    "position": "Product Designer",
    "profile_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "resume_file_name": "adam-hart-resume.pdf",
    "school": "",
    "social_links": [
      {
        "type": "LinkedIn",
        "url": "https://linkedin.com/in/adamhart"
      }
    ],
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "tags": [
      {
        "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
        "title": "Strong candidate"
      }
    ],
    "timezone": "America/Los_Angeles",
    "updated_at": "2026-10-16T10:30:00.000Z",
    "website_url": ""
  }
}

Get job

Get a job: its status, location, department, hiring team and interview plans.

Inputs

Jobjob_idtextRequired
The job. Pick one, or give its ID from an earlier step.

Outputs

jobobject
The job
Example output
{
  "job": {
    "closed_at": "",
    "confidential": false,
    "created_at": "2026-09-01T00:00:00.000Z",
    "custom_fields": [],
    "default_interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
    "department_id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "employment_type": "FullTime",
    "hiring_team": [],
    "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
    "interview_plan_ids": [
      "d3f4762e-1234-4abc-9876-aabbccddeeff"
    ],
    "job_posting_ids": [
      "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
    ],
    "location": "San Francisco",
    "location_id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
    "opened_at": "2026-09-02T00:00:00.000Z",
    "requisition_id": "DES-12",
    "status": "Open",
    "title": "Product Designer",
    "updated_at": "2026-10-15T10:30:00.000Z"
  }
}

Get offer

Get an offer at its latest version: status, the candidate's answer, start date, salary and approval.

Inputs

Offeroffer_idtextRequired
The offer's ID, from 'List offers' or an earlier step.

Outputs

offerobject
The offer
Example output
{
  "offer": {
    "acceptance_status": "Pending",
    "application_id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "approval_status": "Approved",
    "created_at": "2026-10-18T02:07:01.594Z",
    "custom_fields": [],
    "decided_at": "",
    "id": "8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88",
    "opening_id": "1bdb1c73-6ed5-4fc2-8486-16ce03a57c67",
    "salary": 150000,
    "salary_currency": "USD",
    "start_date": "2026-12-01",
    "status": "WaitingOnCandidateResponse",
    "version_id": "698a9280-0a1d-4e72-acd0-b45c771363e8"
  }
}

List applications

List applications, optionally for one job, with one status, or made in a date range. Each shows the candidate, job and current stage.

Inputs

Jobjob_idtext
Only applications for this job.
Statusstatustext
Only applications with this status.One of: Active, Lead (Lead (sourced, not yet applied)), Hired, Archived.
Created aftercreated_afterdate and time
Only those created at or after this time.
Created beforecreated_beforedate and time
Only those created at or before this time.
Page sizelimitnumber
How many to return, 1 to 100. Ashby's default is 100.From 1 to 100.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

applicationslist
The applications
countnumber
How many are in this page
has_moretrue/false
Whether there are more than this page holds
next_cursortext
Give this as the next page cursor to get the next page; empty on the last
Example output
{
  "applications": [
    {
      "archive_reason": "",
      "archive_reason_id": "",
      "archived_at": "",
      "candidate_email": "adam.hart@example.com",
      "candidate_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "candidate_name": "Adam Hart",
      "candidate_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "created_at": "2026-10-15T10:30:00.000Z",
      "credited_to_user": "Jane Smith",
      "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
      "custom_fields": [],
      "hiring_team": [
        {
          "email": "jane.smith@example.com",
          "name": "Jane Smith",
          "role": "Recruiter",
          "user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d"
        }
      ],
      "id": "f9e52a51-a075-4116-a7b8-484deba69004",
      "interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
      "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
      "job_title": "Product Designer",
      "source": "Referral",
      "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
      "stage": "Phone Screen",
      "stage_id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
      "stage_type": "Active",
      "status": "Active",
      "updated_at": "2026-10-16T10:30:00.000Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List candidate notes

List the notes on a candidate's profile, newest first.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.
Page sizelimitnumber
How many to return, 1 to 100. Ashby's default is 100.From 1 to 100.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are in this page
has_moretrue/false
Whether there are more than this page holds
next_cursortext
Give this as the next page cursor to get the next page; empty on the last
noteslist
The notes, newest first
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "notes": [
    {
      "author": "Jane Smith",
      "author_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
      "content": "Strong portfolio; keen to talk about the design system.",
      "created_at": "2026-10-15T10:30:00.000Z",
      "id": "5fa61e0b-3c4d-4e5f-9a0b-1c2d3e4f5a6b",
      "is_private": false
    }
  ]
}

List interview feedback

List the scorecards and feedback interviewers submitted on an application, each question with its answer.

Inputs

Applicationapplication_idtextRequired
The application's ID, from 'List applications', a trigger or an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. Ashby's default is 100.From 1 to 100.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are in this page
feedbacklist
The feedback submitted
has_moretrue/false
Whether there are more than this page holds
next_cursortext
Give this as the next page cursor to get the next page; empty on the last
Example output
{
  "count": 1,
  "feedback": [
    {
      "answers": [
        {
          "answer": "Hire",
          "question": "Overall Recommendation"
        }
      ],
      "application_id": "f9e52a51-a075-4116-a7b8-484deba69004",
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "interview_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
      "submitted_at": "2026-10-16T14:30:00.000Z",
      "submitted_by": "Sarah Johnson",
      "submitted_by_user_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

List interview schedules

List scheduled interviews, with their times, interviewers and video links, for one application or the whole organization.

Inputs

Applicationapplication_idtext
Only this application's interviews.
Created aftercreated_afterdate and time
Only those created at or after this time.
Page sizelimitnumber
How many to return, 1 to 100. Ashby's default is 100.From 1 to 100.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are in this page
has_moretrue/false
Whether there are more than this page holds
next_cursortext
Give this as the next page cursor to get the next page; empty on the last
scheduleslist
The interview schedules
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "schedules": [
    {
      "application_id": "f9e52a51-a075-4116-a7b8-484deba69004",
      "created_at": "2026-10-16T09:00:00.000Z",
      "events": [
        {
          "end_time": "2026-10-20T18:00:00.000Z",
          "feedback_link": "https://app.ashbyhq.com/feedback/abc",
          "has_submitted_feedback": false,
          "id": "0d7f1d4e-cdb1-4d72-9c1d-9b1d4d72e0bd",
          "interviewers": [
            "Sarah Johnson"
          ],
          "location": "",
          "meeting_link": "https://meet.example.com/abc",
          "start_time": "2026-10-20T17:00:00.000Z",
          "title": "Portfolio review"
        }
      ],
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba00840",
      "scheduled_by": "Jane Smith",
      "stage_id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
      "status": "Scheduled",
      "updated_at": "2026-10-16T09:00:00.000Z"
    }
  ]
}

List jobs

List jobs, optionally only those with certain statuses.

Inputs

Statusstatuslist
Only jobs with these statuses. Leave empty for all.One or more of: Open, Draft, Closed, Archived.
Page sizelimitnumber
How many to return, 1 to 100. Ashby's default is 100.From 1 to 100.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are in this page
has_moretrue/false
Whether there are more than this page holds
jobslist
The jobs
next_cursortext
Give this as the next page cursor to get the next page; empty on the last
Example output
{
  "count": 1,
  "has_more": false,
  "jobs": [
    {
      "closed_at": "",
      "confidential": false,
      "created_at": "2026-09-01T00:00:00.000Z",
      "custom_fields": [],
      "default_interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
      "department_id": "f9e52a51-a075-4116-a7b8-484deba69004",
      "employment_type": "FullTime",
      "hiring_team": [],
      "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
      "interview_plan_ids": [
        "d3f4762e-1234-4abc-9876-aabbccddeeff"
      ],
      "job_posting_ids": [
        "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
      ],
      "location": "San Francisco",
      "location_id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
      "opened_at": "2026-09-02T00:00:00.000Z",
      "requisition_id": "DES-12",
      "status": "Open",
      "title": "Product Designer",
      "updated_at": "2026-10-15T10:30:00.000Z"
    }
  ],
  "next_cursor": ""
}

List offers

List offers with their status, start date and salary, optionally for one application or with the candidate's answer.

Inputs

Applicationapplication_idtext
Only this application's offers.
Candidate's answeracceptance_statuslist
Only offers with these answers. Leave empty for all.One or more of: Pending (Waiting on the candidate), Accepted, Declined, Created (Not sent yet), Cancelled.
Created aftercreated_afterdate and time
Only those created at or after this time.
Page sizelimitnumber
How many to return, 1 to 100. Ashby's default is 100.From 1 to 100.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many are in this page
has_moretrue/false
Whether there are more than this page holds
next_cursortext
Give this as the next page cursor to get the next page; empty on the last
offerslist
The offers, each at its latest version
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "offers": [
    {
      "acceptance_status": "Pending",
      "application_id": "f9e52a51-a075-4116-a7b8-484deba69004",
      "approval_status": "Approved",
      "created_at": "2026-10-18T02:07:01.594Z",
      "custom_fields": [],
      "decided_at": "",
      "id": "8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88",
      "opening_id": "1bdb1c73-6ed5-4fc2-8486-16ce03a57c67",
      "salary": 150000,
      "salary_currency": "USD",
      "start_date": "2026-12-01",
      "status": "WaitingOnCandidateResponse",
      "version_id": "698a9280-0a1d-4e72-acd0-b45c771363e8"
    }
  ]
}

Move application to another job

Transfer an application to a different job, at a stage of that job's interview plan.

Inputs

Applicationapplication_idtextRequired
The application's ID, from 'List applications', a trigger or an earlier step.
New jobjob_idtextRequired
The job to move it to.
StagestagetextRequired
A stage of the job's interview plan. Pick one, or type its name, such as Phone Screen, or a type, such as Offer.
Start the stage's automatic stepsstart_automatic_activitiestrue/false
Run what the stage does on its own, such as sending a scheduling email. Defaults to yes.

Outputs

applicationobject
The application
Example output
{
  "application": {
    "archive_reason": "",
    "archive_reason_id": "",
    "archived_at": "",
    "candidate_email": "adam.hart@example.com",
    "candidate_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "candidate_name": "Adam Hart",
    "candidate_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [],
    "hiring_team": [
      {
        "email": "jane.smith@example.com",
        "name": "Jane Smith",
        "role": "Recruiter",
        "user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d"
      }
    ],
    "id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
    "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
    "job_title": "Product Designer",
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "stage": "Phone Screen",
    "stage_id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
    "stage_type": "Active",
    "status": "Active",
    "updated_at": "2026-10-16T10:30:00.000Z"
  }
}

Move application to stage

Move an application to another stage of its interview plan, such as Onsite or Offer. To reject, use 'Archive application'.

Inputs

Applicationapplication_idtextRequired
The application's ID, from 'List applications', a trigger or an earlier step.
StagestagetextRequired
The stage to move to. Pick a name, or type one; it's looked up in the application's own interview plan. A type, such as Offer or Hired, works too.

Outputs

applicationobject
The application
Example output
{
  "application": {
    "archive_reason": "",
    "archive_reason_id": "",
    "archived_at": "",
    "candidate_email": "adam.hart@example.com",
    "candidate_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "candidate_name": "Adam Hart",
    "candidate_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [],
    "hiring_team": [
      {
        "email": "jane.smith@example.com",
        "name": "Jane Smith",
        "role": "Recruiter",
        "user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d"
      }
    ],
    "id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
    "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
    "job_title": "Product Designer",
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "stage": "Phone Screen",
    "stage_id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
    "stage_type": "Active",
    "status": "Active",
    "updated_at": "2026-10-16T10:30:00.000Z"
  }
}

Remove tag from candidate

Take a tag off a candidate. The tag itself stays in Ashby.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.
TagtagtextRequired
The tag to take off. Pick one, or type its name.

Outputs

candidateobject
The candidate, with its tags
tag_idtext
The tag's ID
Example output
{
  "candidate": {
    "application_ids": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "company": "Acme",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [
      {
        "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
        "title": "Preferred Team",
        "value": "Design"
      }
    ],
    "email": "adam.hart@example.com",
    "emails": [
      "adam.hart@example.com"
    ],
    "fraud_status": "",
    "github_url": "",
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "linkedin_url": "https://linkedin.com/in/adamhart",
    "location": "San Francisco, California, United States",
    "name": "Adam Hart",
    "phone": "+1 415 555 0100",
    "phones": [
      "+1 415 555 0100"
    ],
    "position": "Product Designer",
    "profile_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "resume_file_name": "adam-hart-resume.pdf",
    "school": "",
    "social_links": [
      {
        "type": "LinkedIn",
        "url": "https://linkedin.com/in/adamhart"
      }
    ],
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "tags": [],
    "timezone": "America/Los_Angeles",
    "updated_at": "2026-10-16T10:30:00.000Z",
    "website_url": ""
  },
  "tag_id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d"
}

Set custom field

Set one of your custom fields on a candidate, application, job or opening. The value is converted to the field's type for you.

Inputs

Fieldfield_idtextRequired
The custom field. Each says which kind of record it's on.
Recordrecord_idtextRequired
The ID of the candidate, application, job or opening the field is on.
ValuevaluetextRequired
The new value. For a yes/no field type yes or no; for a choice, the option's name (several separated by commas); for money, like 100000 USD.

Outputs

field_idtext
The custom field's ID
record_idtext
The record it was set on
record_typetext
Candidate, Application, Job or Opening
titletext
The custom field's name
valuetext
Its value now, as text
Example output
{
  "field_id": "650e5f74-32db-4a0a-b61b-b9afece05023",
  "record_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "record_type": "Candidate",
  "title": "Preferred Team",
  "value": "Design"
}

Set job status

Open, close or archive a job, or put it back to draft.

Inputs

Jobjob_idtextRequired
The job. Pick one, or give its ID from an earlier step.
StatusstatustextRequired
The job's new status.One of: Open, Draft, Closed, Archived.
Close reasonclose_reason_idtext
Why the job is closing.Only when Status is Closed.

Outputs

jobobject
The job
Example output
{
  "job": {
    "closed_at": "",
    "confidential": false,
    "created_at": "2026-09-01T00:00:00.000Z",
    "custom_fields": [],
    "default_interview_plan_id": "d3f4762e-1234-4abc-9876-aabbccddeeff",
    "department_id": "f9e52a51-a075-4116-a7b8-484deba69004",
    "employment_type": "FullTime",
    "hiring_team": [],
    "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
    "interview_plan_ids": [
      "d3f4762e-1234-4abc-9876-aabbccddeeff"
    ],
    "job_posting_ids": [
      "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
    ],
    "location": "San Francisco",
    "location_id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
    "opened_at": "2026-09-02T00:00:00.000Z",
    "requisition_id": "DES-12",
    "status": "Closed",
    "title": "Product Designer",
    "updated_at": "2026-10-15T10:30:00.000Z"
  }
}

Update candidate

Change a candidate's details. Only the fields you fill in change; a new email or phone becomes their primary one.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.
Namenametext
A new name. Leave empty to keep it.
Emailemailtext
A new primary email address. Leave empty to keep it.
Phonephonetext
Their phone number, ideally with the country code.
LinkedIn profilelinkedin_urltext
A link to their LinkedIn profile.
GitHub profilegithub_urltext
A link to their GitHub profile.
Websitewebsite_urltext
A link to their own website or portfolio.
Citycitytext
The city they live in.
State or regionregiontext
Their state, province or region.
Countrycountrytext
The country they live in.
Sourcesource_idtext
Where the candidate came from, such as Referral or LinkedIn.
Credited tocredited_to_user_idtext
The teammate who gets credit for bringing them in.
Notify followersnotify_followerstrue/false
Tell the teammates who follow this candidate in Ashby. Defaults to yes for an update and no for a note.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "application_ids": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "company": "Acme",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [
      {
        "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
        "title": "Preferred Team",
        "value": "Design"
      }
    ],
    "email": "adam.hart@example.com",
    "emails": [
      "adam.hart@example.com"
    ],
    "fraud_status": "",
    "github_url": "",
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "linkedin_url": "https://linkedin.com/in/adamhart",
    "location": "San Francisco, California, United States",
    "name": "Adam Hart",
    "phone": "+1 415 555 0100",
    "phones": [
      "+1 415 555 0100"
    ],
    "position": "Product Designer",
    "profile_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "resume_file_name": "adam-hart-resume.pdf",
    "school": "",
    "social_links": [
      {
        "type": "LinkedIn",
        "url": "https://linkedin.com/in/adamhart"
      }
    ],
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "tags": [
      {
        "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
        "title": "Strong candidate"
      }
    ],
    "timezone": "America/Los_Angeles",
    "updated_at": "2026-10-16T10:30:00.000Z",
    "website_url": ""
  }
}

Upload candidate resume

Attach a resume to a candidate, such as one from an email. It becomes their current resume, and Ashby reads it for their details.

Inputs

Candidatecandidate_idtextRequired
The candidate's ID, from 'Find candidates' or an earlier step, or a link to them copied from Ashby.
ResumeresumetextRequired
The resume file, usually a PDF or Word document.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "application_ids": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "company": "Acme",
    "created_at": "2026-10-15T10:30:00.000Z",
    "credited_to_user": "Jane Smith",
    "credited_to_user_id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "custom_fields": [
      {
        "id": "650e5f74-32db-4a0a-b61b-b9afece05023",
        "title": "Preferred Team",
        "value": "Design"
      }
    ],
    "email": "adam.hart@example.com",
    "emails": [
      "adam.hart@example.com"
    ],
    "fraud_status": "",
    "github_url": "",
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "linkedin_url": "https://linkedin.com/in/adamhart",
    "location": "San Francisco, California, United States",
    "name": "Adam Hart",
    "phone": "+1 415 555 0100",
    "phones": [
      "+1 415 555 0100"
    ],
    "position": "Product Designer",
    "profile_url": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "resume_file_name": "adam-hart-resume.pdf",
    "school": "",
    "social_links": [
      {
        "type": "LinkedIn",
        "url": "https://linkedin.com/in/adamhart"
      }
    ],
    "source": "Referral",
    "source_id": "5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7",
    "tags": [
      {
        "id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
        "title": "Strong candidate"
      }
    ],
    "timezone": "America/Los_Angeles",
    "updated_at": "2026-10-16T10:30:00.000Z",
    "website_url": ""
  }
}

On this page