# Ashby API API

> Ashby API API on Apizie: 90 endpoints (apiKey.info, application.changeSource, application.changeStage, application.create, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/open-data:ashby/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:ashby`
- Category: Open Data
- Status: byok
- Source: https://ashbyhq.com
- Page: https://zieapi.vercel.app/api/open-data/ashby
- OpenAPI: https://zieapi.vercel.app/api/open-data/ashby/openapi.json

The public API for accessing resources in your Ashby instance.

## Endpoints

### apiKey.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/api-key-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### application.changeSource
`POST https://zieapi.vercel.app/v1/open-data:ashby/application-change-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### application.changeStage
`POST https://zieapi.vercel.app/v1/open-data:ashby/application-change-stage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### application.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/application-consider-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### application.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/application-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### application.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/application-get-all-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### applicationFeedback.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/application-feedback-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### applicationFeedback.submit
`POST https://zieapi.vercel.app/v1/open-data:ashby/application-feedback-submit-feedback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### applicationForm.submit
`POST https://zieapi.vercel.app/v1/open-data:ashby/application-form-submit-form` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### approvalDefinition.update
`POST https://zieapi.vercel.app/v1/open-data:ashby/approval-definition-update-entity-scope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### archiveReason.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/archive-reason-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### assessment.addCompletedToCandidate
`POST https://zieapi.vercel.app/v1/open-data:ashby/assessment-add-completed-to-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### assessment.start (Implemented by Partner)
`POST https://zieapi.vercel.app/v1/open-data:ashby/assessment-partner-start` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### assessment.list (Implemented by Partner)
`POST https://zieapi.vercel.app/v1/open-data:ashby/assessment-list-partner-support` (byok)

### assessment.update
`POST https://zieapi.vercel.app/v1/open-data:ashby/assessment-update-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### assessment.cancel (Implemented by Partner)
`POST https://zieapi.vercel.app/v1/open-data:ashby/assessment-cancel-partner-assessment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.addTag
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-add-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.anonymize
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-anonymize-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-create-new-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.createNote
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-create-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### candidate.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.listNotes
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-get-all-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.search
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-search-by-email-and-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.update
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-update-existing-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidate.uploadFile
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-attach-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### candidate.uploadResume
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-upload-resume-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### candidateTag.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-tag-create-new-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### candidateTag.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/candidate-tag-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### customField.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/custom-field-create-new-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### customField.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/custom-field-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### customField.setValue
`POST https://zieapi.vercel.app/v1/open-data:ashby/custom-field-set-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### department.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/department-team-create-new-department` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### department.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/department-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### department.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/department-get-all-departments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### file.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/file-get-url-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### feedbackFormDefinition.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/feedback-form-definition-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### feedbackFormDefinition.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/feedback-form-definition-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### hiringTeam.addMember
`POST https://zieapi.vercel.app/v1/open-data:ashby/hiring-team-add-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### hiringTeamRole.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/hiring-team-role-list-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interview.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interview.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interviewEvent.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-event-list-associated-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interviewPlan.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-plan-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interviewSchedule.cancel
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-schedule-cancel-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interviewSchedule.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-schedule-create-scheduled-interview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interviewSchedule.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-schedule-get-all-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interviewSchedule.update
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-schedule-update-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interviewStage.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-stage-list-all-in-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### interviewStage.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/interview-stage-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### job.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-new-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### job.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### job.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### job.setStatus
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-set-status-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### job.update
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-update-existing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### job.search
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-search-by-title` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### jobInterviewPlan.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-interview-plan-get-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### jobPosting.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-posting-get-individual` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### jobPosting.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-posting-get-all-published` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### jobPosting.update
`POST https://zieapi.vercel.app/v1/open-data:ashby/job-posting-update-existing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### location.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/location-create-hierarchy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### location.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/location-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### location.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/location-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### offer.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/offer-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### offer.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/offer-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### offer.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/offer-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### offer.start
`POST https://zieapi.vercel.app/v1/open-data:ashby/offer-start-creation-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### offerProcess.start
`POST https://zieapi.vercel.app/v1/open-data:ashby/offer-process-start-process-for-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-get-by-uuid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.search
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-search-by-identifier` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.addJob
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-add-job-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.removeJob
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-remove-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.setOpeningState
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-set-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.setArchived
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-set-archived` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### opening.update
`POST https://zieapi.vercel.app/v1/open-data:ashby/openings-update-opening` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### referral.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/referral-create-new` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### referralForm.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/referral-form-get-default-form` (byok)

### source.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/source-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### surveyFormDefinition.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/survey-form-definition-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### surveyFormDefinition.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/survey-form-definition-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### surveyRequest.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/survey-request-generate-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### surveySubmission.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/survey-submission-list-by-survey-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### user.info
`POST https://zieapi.vercel.app/v1/open-data:ashby/user-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### user.list
`POST https://zieapi.vercel.app/v1/open-data:ashby/user-get-ashby-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### user.search
`POST https://zieapi.vercel.app/v1/open-data:ashby/user-search-by-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### webhook.create
`POST https://zieapi.vercel.app/v1/open-data:ashby/webhook-create-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### webhook.update
`POST https://zieapi.vercel.app/v1/open-data:ashby/webhook-update-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### webhook.delete
`POST https://zieapi.vercel.app/v1/open-data:ashby/webhook-remove-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:ashby/api-key-get-info" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Ashby API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/open-data:ashby/api-key-get-info with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Ashby API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Ashby API itself also needs your own key from api.ashbyhq.com.

### Can AI agents use the Ashby API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:ashby.

### What is the status of the Ashby API API?
Needs your own provider key (bring your own key)