Ashby integration: operations for AI agents
Ashby connects to Type.com as an integration. This page lists the 203 operations documented for Claude and Codex in Type.com: 84 read, 92 write, 27 destructive.
About Ashby
Ashby API reference operations, subject to Type setup and account permissions.
Categories: HR & Recruiting
How to connect Ashby to Type.com
- Connect
- Configure provider-specific API target and Basic authentication setup.
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
203 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
203 operations listed.
API Key
- Read
apiKey.info
Returns details for the API key used to make the request. **Requires the [`apiKeysRead`](authentication#permissions-apikeyinfo) permission.**
POST /apiKey.info
Audit Log
- Read
auditLog.list
> Beta > > **This API is in active development and only available in a closed beta with early design partners.** Lists an organization's audit log entries, newest first. The `targetTypes` and `categories` you can filter on are a fixed, code-defined vocabulary; see the [Audit Log Vocabulary](/reference/audit-log-vocabulary) guide for valid values and filter examples. **Pagination:** follow opaque `cursor` / `nextCursor`; see [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync). Returns audit events for **all** objects in the organization, including confidential jobs and projects, with no confidentiality filtering. **Retention of request metadata:** entries older than 30 days do not retain the request that triggered them, so `request.id` and `request.ipAddress` are always `null` on those entries. Because the cutoff is relative to the time of the request, an entry that includes request metadata today returns it as `null` once it ages past 30 days, and a single page can contain entries on both sides of the cutoff. **Error codes:** | Code | Description | |---|---| | `invalid_input` | A date bound is not a valid ISO 8601 date, `endDate` is before `startDate`, the explicit span exceeds 18 months, or a `targetTypes` / `categories` value is not in the vocabulary. | | `audit_logs_not_enabled` | Your organization does not have the Audit Logs feature. | | `cursor_invalid` | The provided `cursor` could not be decoded. | | `missing_endpoint_permission` | The API key lacks the `auditLogsRead` scope. Returned with HTTP `403`. | **Requires the [`auditLogsRead`](authentication#permissions-auditloglist) permission.**
POST /auditLog.list
Application
- Read
application.list
Gets all applications in the organization. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`candidatesRead`](authentication#permissions-applicationlist) permission.**
POST /application.list - Read
application.info
Fetch application details by application id or by submitted form instance id (which is returned by the `applicationForm.submit` endpoint). If both `applicationId` and `submittedFormInstanceId` are provided, the lookup uses `applicationId`. **Requires the [`candidatesRead`](authentication#permissions-applicationinfo) permission.**
POST /application.info - Read
application.listHistory
Fetch a paginated list of application history items for an application. This endpoint supports pagination only (not incremental sync). See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for usage examples. **Requires the [`candidatesRead`](authentication#permissions-applicationlisthistory) permission.**
POST /application.listHistory - Read
application.listCriteriaEvaluations
Fetch a paginated list of AI criteria evaluations for an application. This endpoint returns the AI-generated criteria evaluations that assess how well a candidate meets specific job requirements. Each evaluation contains the outcome, reasoning, and other assessment details. This endpoint supports pagination only (not incremental sync). See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for usage examples. **Note:** This endpoint requires the AI Application Review feature to be enabled for your organization. **Requires the [`candidatesRead`](authentication#permissions-applicationlistcriteriaevaluations) permission.**
POST /application.listCriteriaEvaluations - Write
application.create
Consider a candidate for a job (e.g. when sourcing a candidate for a job posting). If you're submitting an application as a job board, use the [`applicationForm.submit`](ref:applicationformsubmit) endpoint instead. See [Creating a custom careers page](https://developers.ashbyhq.com/docs/creating-a-custom-careers-page) for details. To set values for custom fields on Applications, use the [`customField.setValue`](ref:customfieldsetvalue) endpoint. **Requires the [`candidatesWrite`](authentication#permissions-applicationcreate) permission.**
POST /application.create - Write
application.update
Update an application. To set values for custom fields on Applications, use the [`customField.setValue`](ref:customfieldsetvalue) endpoint. **Requires the [`candidatesWrite`](authentication#permissions-applicationupdate) permission.**
POST /application.update - Write
application.addHiringTeamMember
Adds an Ashby user to the hiring team at the application level. **Requires the [`candidatesWrite`](authentication#permissions-applicationaddhiringteammember) permission.**
POST /application.addHiringTeamMember - Write
application.change_stage
**Deprecated.** Use [`application.changeStage`](ref:applicationchangestage) instead. Change the stage of an application. **Requires the [`candidatesWrite`](authentication#permissions-applicationchange_stage) permission.**
POST /application.change_stage - Write
application.changeStage
Change the stage of an application. **Requires the [`candidatesWrite`](authentication#permissions-applicationchangestage) permission.**
POST /application.changeStage - Write
application.change_source
**Deprecated.** Use [`application.changeSource`](ref:applicationchangesource) instead. Change the source of an application. **Requires the [`candidatesWrite`](authentication#permissions-applicationchange_source) permission.**
POST /application.change_source - Write
application.changeSource
Change the source of an application. **Requires the [`candidatesWrite`](authentication#permissions-applicationchangesource) permission.**
POST /application.changeSource - Write
application.transfer
Transfer an application to a different job. **Requires the [`candidatesWrite`](authentication#permissions-applicationtransfer) permission.**
POST /application.transfer - Destructive
application.delete
Deletes an application by id. **Requires the [`candidatesDelete`](authentication#permissions-applicationdelete) permission.**
POST /application.delete - Destructive
application.removeHiringTeamMember
Unassigns a hiring team role from an Ashby user at the application level. **Requires the [`candidatesWrite`](authentication#permissions-applicationremovehiringteammember) permission.**
POST /application.removeHiringTeamMember - Destructive
application.updateHistory
Update the history of an application. Used to update stage timestamps and to delete history events. **Also requires the `Allow updating application history?` setting found in your admin API key permissions configuration.** **Requires the [`candidatesWrite`](authentication#permissions-applicationupdatehistory) permission.**
POST /application.updateHistory
Application Hiring Team Role
- Read
applicationHiringTeamRole.list
Gets all available hiring team roles for applications in the organization. **Requires the [`candidatesRead`](authentication#permissions-applicationhiringteamrolelist) permission.**
POST /applicationHiringTeamRole.list
Application Feedback
- Read
applicationFeedback.list
List all interview scorecards and feedback submissions associated with an application. Each feedback submission contains: - **formDefinition**: The structure of the feedback form with all available fields - **submittedValues**: Responses to the form fields, which depending on the form configuration can include: - Text feedback (e.g., "Candidate showed strong technical skills...") - Numerical scores (e.g., "4" for a 1-4 rating scale) - Structured selections, returned as the stored option value rather than its display label (e.g., "hire", not "Hire"); use the field's `selectableValues` in `formDefinition` to map values to labels - **Interview context**: Links to associated interviews, events, and the submitting user See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`candidatesRead`](authentication#permissions-applicationfeedbacklist) permission.**
POST /applicationFeedback.list - Write
applicationFeedback.submit
Submit feedback for an application using the field paths and types from its feedback form. Use [`feedbackFormDefinition.info`](feedbackformdefinitioninfo) to read a form's fields. Without `interviewEventId`, each successful call creates a separate feedback submission. To submit or edit feedback for an interviewer, provide `interviewEventId` and that interviewer's `userId`. The `applicationId` must match the interview, and `formDefinitionId` must identify the form assigned to it. If that interviewer has already submitted feedback, this updates their existing submission. Your feedback-editing settings and access permissions apply. The values accepted for each field depend on the type of field that's being filled out: - `Boolean` - A boolean value - `CompensationRange` - An object in the format `{ type: "compensation-range", minValue: 100000, maxValue: 150000, currencyCode: "USD", interval: "1 YEAR" }`. `currencyCode` must be a valid ISO 4217 code and `interval` must be a valid compensation interval (e.g. `"1 HOUR"`, `"1 YEAR"`). - `Currency` - An object in the format `{ value: 100000, currencyCode: "USD" }`. `currencyCode` must be a valid ISO 4217 code. - `Date` - A date string in the format YYYY-MM-DD - `Email` - A valid email address - `LongText`, `Phone`, `String` - A string - `MultiValueSelect` - An array of strings that exist in the MultiValueSelect field's selectable options - `Number` - An integer - `NumberRange` - An object in the format `{ type: "number-range", minValue: 1, maxValue: 10 }` - `RichText` - Plain text as `{ type: "text/plain", value: "A plain text string" }`, or HTML as `{ type: "text/html", value: "<p><strong>Strong</strong> design.</p>" }` - `Score` - An object in the format `{ score: 4 }` where `score` is an integer between 1 and 4 inclusive. Optionally include `comments` as plain text or HTML, for example `{ score: 4, comments: { type: "text/html", value: "<p>Explained <em>tradeoffs</em> clearly.</p>" } }`. Omitted or null comments are treated as absent. See the response format below. - `Url` - A valid URL string. The empty string is also accepted. - `UUID` - A UUID string, or an object in the format `{ value: "<uuid>" }` - `ValueSelect` - A string that matches the value of one of the ValueSelect field's selectable options **HTML formatting** For RichText answers and Score comments, use `type: "text/plain"` for plain text or `type: "text/html"` for HTML. API version `2026-01-01` also accepts `type: "PlainText"` as a compatibility alias for plain text. Supported HTML formatting includes paragraphs, line breaks, bold, italic, underline, inline code, code blocks, headings, numbered and bulleted lists, and links. Unsupported formatting and unsafe HTML are removed. An empty HTML string submits an empty answer. **Keeping existing images when editing** You can keep images already saved in the interview feedback submission you are editing, including images in rating comments. Include their existing image markup in the HTML you submit. Keep the `data-attachment-id` on the surrounding `div` and the image's `src` unchanged. For example: `<div data-attachment-id="<existing-id>" style="text-align: center"><img src="<existing-src>" width="640" alt="Architecture diagram" title="System design"></div>` You can change the image's alignment, width, alt text and title. Images omitted from an answer's submitted HTML are removed from that answer. You cannot add new images or reuse images from other feedback. Unsupported image references return `invalid_field_provided_for_form`. **Response** `results.submittedFormInstance.submittedValues` contains the submitted answers keyed by field path. RichText answers and nested Score comments are returned as `{ type: "PlainText", value: "..." }`, including when submitted as HTML. **Requires the [`candidatesWrite`](authentication#permissions-applicationfeedbacksubmit) permission.**
POST /applicationFeedback.submit
Application Feedback Request
- Write
applicationFeedbackRequest.create
Request feedback on an application without scheduling an interview. The `interviewEventId` returned in the response can be provided to `applicationFeedback.submit` to complete the feedback request. The interview used must be configured to request feedback. **Requires the [`candidatesWrite`](authentication#permissions-applicationfeedbackrequestcreate) permission.**
POST /applicationFeedbackRequest.create
Application Form
- Write
applicationForm.submit
Submits a completed application form for a job posting. See [Creating a Custom Careers Page](/docs/creating-a-custom-careers-page) for the full flow. **Requires the [`candidatesWrite`](authentication#permissions-applicationformsubmit) permission.**
POST /applicationForm.submit
Approval Definition
- Write
approvalDefinition.update
Create or update an approval definition for a specific entity that requires approval. The entity requiring approval must be within scope of an approval in Ashby that is marked as being managed by the API. If the provided approval step definitions is an empty list, then approval will be skipped and the entity will proceed to the next stage. **Requires the [`approvalsWrite`](authentication#permissions-approvaldefinitionupdate) permission.**
POST /approvalDefinition.update
Candidate
- Read
candidate.list
Lists all candidates in the organization with pagination and incremental sync support. Use the `syncToken` parameter to retrieve only candidates updated since your last sync. Use `createdAfter` to filter candidates by creation date. **Requires the [`candidatesRead`](authentication#permissions-candidatelist) permission.**
POST /candidate.list - Read
candidate.getRecentEmailMessages
> Beta > > This feature is in beta and may not be available for all organizations. Returns recent email messages for a candidate, newest first. A request without a `cursor` starts a point-in-time snapshot containing at most 200 matching messages. Continue with `nextCursor` while `moreDataAvailable` is true, repeating the same `candidateId`, `direction`, `sentAfter`, and `watermark` values on every request. Omit `cursor` to start a new snapshot that includes the latest available messages. `snapshotTruncated` means additional older matching messages may exist beyond the snapshot's 200-message window. When refreshing after a `candidateRecentEmailMessagesUpdated` webhook, pass `data.watermark` unchanged and omit `cursor`. Only a request with that watermark is guaranteed to include the up-to-date email change that triggered the webhook. The watermark applies only to that candidate and is valid for starting the first page for one hour from the delivery attempt. If the first page is accepted within the hour, remaining pages can complete after the watermark expires. Pages may be shorter than `limit` because response byte limits and body truncation apply. Message bodies contain untrusted HTML and must be sanitized before rendering. `bodyTruncated` indicates that Ashby shortened a body to satisfy response-size limits. **Error codes:** | Code | Description | |---|---| | `response_too_large` | A one-message response still exceeds the response safety limit after body truncation. | | `watermark_expired` | The watermark is older than one hour and this is a cursorless first-page request. | `recordId` is not a durable message identifier; do not persist it as one. `source` indicates where the returned content came from (`ashby`, `sync`, `import`, or `public_api`). BCC may be null when unavailable. For emails sent through Ashby, `receivedReply` is true when a reply was received, false when no reply is recorded, and null when unavailable or not applicable. A non-null `sequenceId` identifies the sourcing sequence associated with the message and matches the `id` returned by [`sequence.list`](https://developers.ashbyhq.com/reference/sequencelist); it is null when no sourcing sequence is available. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for general cursor usage. **Requires the [`emailsRead`](authentication#permissions-candidategetrecentemailmessages) permission.**
POST /candidate.getRecentEmailMessages - Read
candidate.search
Searches for candidates by email and/or name. **Requires the [`candidatesRead`](authentication#permissions-candidatesearch) permission.**
POST /candidate.search - Read
candidate.searchSuggestions
Searches for candidates by email and/or name and returns a minimal suggestion shape for typeahead use cases. **Requires the [`candidatesRead`](authentication#permissions-candidatesearchsuggestions) permission.**
POST /candidate.searchSuggestions - Read
candidate.info
Fetches details about a single candidate by id or external mapping id. **Requires the [`candidatesRead`](authentication#permissions-candidateinfo) permission.**
POST /candidate.info - Read
candidate.listClientInfo
Lists client information records (IP, user agent) collected for a candidate. **Requires the [`candidatesRead`](authentication#permissions-candidatelistclientinfo) permission.**
POST /candidate.listClientInfo - Read
candidate.listFraudChecks
Lists the fraud checks performed on a candidate. **Requires the [`candidatesRead`](authentication#permissions-candidatelistfraudchecks) permission.**
POST /candidate.listFraudChecks - Read
candidate.listNotes
Lists the notes that have been added to a candidate, ordered from newest to oldest. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for cursor usage examples. **Requires the [`candidatesRead`](authentication#permissions-candidatelistnotes) permission.**
POST /candidate.listNotes - Read
candidate.listProjects
Lists the projects a candidate has been added to. **Requires the [`candidatesRead`](authentication#permissions-candidatelistprojects) permission.**
POST /candidate.listProjects - Write
candidate.create
Creates a new candidate. **Requires the [`candidatesWrite`](authentication#permissions-candidatecreate) permission.**
POST /candidate.create - Write
candidate.uploadResume
Uploads a resume for a candidate. Accepts either a multipart/form-data request with a `resume` file part, or a JSON body with a `resumeHandle` previously created via `file.createFileUploadHandle`. **Requires the [`candidatesWrite`](authentication#permissions-candidateuploadresume) permission.**
POST /candidate.uploadResume - Write
candidate.uploadFile
Uploads a file for a candidate. Accepts either a multipart/form-data request with a `file` file part, or a JSON body with a `fileHandle` previously created via `file.createFileUploadHandle`. **Requires the [`candidatesWrite`](authentication#permissions-candidateuploadfile) permission.**
POST /candidate.uploadFile - Write
candidate.update
Updates an existing candidate. **Requires the [`candidatesWrite`](authentication#permissions-candidateupdate) permission.**
POST /candidate.update - Write
candidate.createNote
Creates a note on a candidate. **Requires the [`candidatesWrite`](authentication#permissions-candidatecreatenote) permission.**
POST /candidate.createNote - Write
candidate.setFraudStatus
Updates the manual fraud-review status of a candidate. **Requires the [`candidatesWrite`](authentication#permissions-candidatesetfraudstatus) permission.**
POST /candidate.setFraudStatus - Write
candidate.addProject
Adds a candidate to a project. **Requires the [`candidatesWrite`](authentication#permissions-candidateaddproject) permission.**
POST /candidate.addProject - Write
candidate.addEmailMessage
Attaches an existing email message (e.g. fetched from a partner provider) to a candidate. **Requires the [`candidatesWrite`](authentication#permissions-candidateaddemailmessage) permission.**
POST /candidate.addEmailMessage - Write
candidate.addTag
Adds a tag to a candidate. **Requires the [`candidatesWrite`](authentication#permissions-candidateaddtag) permission.**
POST /candidate.addTag - Write
candidate.pushToHris
> Beta > > This feature is in beta and may not be available for all organizations. Pushes a candidate's data to an HRIS system (e.g. Workday, BambooHR, ADP). This endpoint triggers the "Add Candidate Data" flow for the specified application and HRIS system. The candidate must have a name, and any offer associated with the application must be in an accepted state (for systems that require it) before pushing. If the candidate has already been pushed to the same system, the push will be retried automatically. For SelfServe integrations, `integrationPartnerId` is required. **Error codes:** | Code | Description | |---|---| | `candidate_hris_push_blocked_by_offer_status` | The candidate's offer is not in a state that permits pushing to this HRIS. | | `candidate_hris_push_failed` | The HRIS did not accept the push (e.g. a data or validation discrepancy reported by the downstream system, or a precondition it requires). The `message` includes detail about the failure (typically the error reported by the HRIS). If any of the data was already applied in the external system, verify there before retrying — this endpoint pushes with re-push enabled, so a blind retry can create a duplicate. | > Retries > > A `generic_internal_error` response does not guarantee the push did not occur — the > candidate mapping and downstream events may already have been created. Do not blindly > retry on this error; check whether the candidate was already pushed first to avoid > duplicate pushes. **Requires the [`candidatesWrite`](authentication#permissions-candidatepushtohris) permission.**
POST /candidate.pushToHris - Destructive
candidate.anonymize
Anonymizes a candidate's personally identifiable information. **Requires the [`candidatesWrite`](authentication#permissions-candidateanonymize) permission.**
POST /candidate.anonymize - Destructive
candidate.removeProject
Removes the candidate from a project. **Requires the [`candidatesWrite`](authentication#permissions-candidateremoveproject) permission.**
POST /candidate.removeProject - Destructive
candidate.removeTag
Removes a tag from a candidate. **Requires the [`candidatesWrite`](authentication#permissions-candidateremovetag) permission.**
POST /candidate.removeTag
Candidate Tag
- Read
candidateTag.list
Lists all candidate tags. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-candidatetaglist) permission.**
POST /candidateTag.list - Write
candidateTag.create
Creates a candidate tag. If a tag already exists with the given title, the existing tag will be returned. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-candidatetagcreate) permission.**
POST /candidateTag.create - Write
candidateTag.archive
Archives a candidate tag. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-candidatetagarchive) permission.**
POST /candidateTag.archive
Email Sync Blocked Address
- Read
emailSyncBlockedAddress.list
Lists the email addresses on the candidate email sync blocklist, oldest first. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`organizationRead`](authentication#permissions-emailsyncblockedaddresslist) permission.**
POST /emailSyncBlockedAddress.list - Write
emailSyncBlockedAddress.create
Adds email addresses to the candidate email sync blocklist. Matching ignores case but is otherwise exact, so `person+tag@example.com` is blocked separately from `person@example.com`. A malformed address rejects the whole batch. An address already on the list returns its existing entry. **Note:** Blocking applies only to addresses stored on a candidate's profile, and requires the blocklist to be enabled for your organization. **Requires the [`organizationWrite`](authentication#permissions-emailsyncblockedaddresscreate) permission.**
POST /emailSyncBlockedAddress.create - Destructive
emailSyncBlockedAddress.delete
Removes email addresses from the candidate email sync blocklist. Addresses must match a listed entry exactly. Removing an address that is not on the list succeeds and is omitted from `removedAddresses`. **Requires the [`organizationWrite`](authentication#permissions-emailsyncblockedaddressdelete) permission.**
POST /emailSyncBlockedAddress.delete
Communication Template
- Read
communicationTemplate.list
List all enabled communication templates. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-communicationtemplatelist) permission.**
POST /communicationTemplate.list
Feedback Form Definition
- Read
feedbackFormDefinition.list
Lists all feedback form definitions. To find active reusable shared forms, send `{ "sharedOnly": true }`. Forms local to an Interview or activity are excluded, including local forms whose `interviewId` is null. Set `includeArchived: true` to also include archived shared forms. Keep the same filters when following pagination cursors or sync tokens. Incremental sync returns matching forms updated since the previous sync; it does not report forms that have left the filtered results. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires one of the [`feedbackFormDefinitionsRead`](authentication#permissions-feedbackformdefinitionlist) or [`hiringProcessMetadataRead`](authentication#permissions-feedbackformdefinitionlist) permissions.**
POST /feedbackFormDefinition.list - Read
feedbackFormDefinition.info
Returns a single feedback form by id **Requires one of the [`feedbackFormDefinitionsRead`](authentication#permissions-feedbackformdefinitioninfo) or [`hiringProcessMetadataRead`](authentication#permissions-feedbackformdefinitioninfo) permissions.**
POST /feedbackFormDefinition.info
Job Posting
- Read
jobPosting.list
Lists published job postings. By default, only published job postings are returned. Set `includeUnpublishedJobPostings` to `true` to also include unpublished (draft) job postings. **Important**: By default, this endpoint includes all listed and unlisted job postings. Unlisted job postings should not be displayed publicly. If you are using the API to publicly expose job postings, set the `listedOnly` parameter to `true` when calling this API so that you only fetch listed job postings that can be displayed publicly. **Requires the [`jobsRead`](authentication#permissions-jobpostinglist) permission.**
POST /jobPosting.list - Read
jobPosting.info
Retrieve an individual job posting. Set `includeUnpublishedJobPostings` to `true` when fetching an unpublished (draft) job posting. This flag is required for draft postings; published postings can be fetched without it. Result fields: - `linkedData` - Object that can be used to populate "rich results" in search engines. [See more info here](https://developers.google.com/search/docs/data-types/job-posting). - `applicationFormDefinition` - See the guide on [Creating a custom careers page](https://developers.ashbyhq.com/docs/creating-a-custom-careers-page). **Requires the [`jobsRead`](authentication#permissions-jobpostinginfo) permission.**
POST /jobPosting.info - Write
jobPosting.create
Creates a new job posting for the specified job. Only `jobId` is required. When `title` is omitted the posting inherits the parent job's title. When `status` is omitted the posting is created in `Draft` status. Side effects: - The new posting is always attached to the external job board for the parent job's brand. This board cannot be overridden today, and this endpoint cannot create a posting on an internal job board. - `isListed` controls whether the posting is listed on that external job board. It defaults to `true` when omitted. Setting it to `false` leaves the posting attached to the board. - If no default posting exists for the parent job, this posting becomes the default. - When the parent job is confidential, `isListed` is forced to `false` regardless of the value provided. **Requires the [`jobsWrite`](authentication#permissions-jobpostingcreate) permission.**
POST /jobPosting.create - Write
jobPosting.updateCompensationSettings
Updates compensation display settings for a job posting. Controls whether and how compensation is shown for this specific posting. Each field uses the null-means-inherit convention: - **Omitted**: leaves the current setting untouched. - **Explicit `null`**: clears the posting-level override so the value inherits from the parent job. - **Any other value**: sets a posting-level override. Set `includeUnpublishedJobPostings` to `true` when updating an unpublished (draft) job posting. Note: organization-level pay transparency settings (e.g. `globalRequiredOnPostings`) can force compensation display on regardless of these settings. The configured values may therefore differ from the computed display behavior visible to candidates. **Requires the [`jobsWrite`](authentication#permissions-jobpostingupdatecompensationsettings) permission.**
POST /jobPosting.updateCompensationSettings - Write
jobPosting.setStatus
Sets the status of a job posting. Use this to publish or unpublish a job posting. Set `status` to `Published` to publish a draft job posting. The posting must have a title, description, and belong to an open job. If the organization requires compensation to be displayed, the posting must also have a valid compensation tier. Set `status` to `Draft` to unpublish a published job posting. **Requires the [`jobsWrite`](authentication#permissions-jobpostingsetstatus) permission.**
POST /jobPosting.setStatus - Destructive
jobPosting.updateCompensation
Updates compensation for an existing job posting. Set `includeUnpublishedJobPostings` to `true` when updating an unpublished (draft) job posting. This flag is required for draft postings; published postings can be updated without it. Pass a non-empty `compensationTiers` array to replace the posting's compensation and stop inheriting compensation from the parent job. Pass `null` to reset the posting to inherit compensation from the parent job. **Requires the [`jobsWrite`](authentication#permissions-jobpostingupdatecompensation) permission.**
POST /jobPosting.updateCompensation - Destructive
jobPosting.update
Updates an existing job posting. Set `includeUnpublishedJobPostings` to `true` when updating an unpublished (draft) job posting. This flag is required for draft postings; published postings can be updated without it. **Note on updating the description**: When job description openings and closings are not suppressed, the `descriptionHtml` field returned in `jobPosting.info` may contain content that is not modifiable through the API. Only the content of the `descriptionParts.descriptionBody` field of the `jobPosting.info` endpoint is modifiable through this call. To completely customize the description, set both suppressDescriptionOpening and suppressDescriptionClosing to true. **Locations**: Use `locationId` to set or clear the primary posting location. Pass `null` to clear the override and fall back to the parent job's location. Use `secondaryLocationIds` to fully replace the set of secondary locations. Pass an empty array to remove all secondary locations. **Application form**: Use `applicationFormDefinitionId` to set or clear the posting's application form override. Pass `null` to fall back to the organization default form. **Job boards**: Use `jobBoardAssociations` to fully replace the Ashby-hosted job boards associated with the posting and set whether it is listed on each board. Pass an empty array to remove the posting from every Ashby-hosted job board. Omit this field to leave the existing associations unchanged. Third-party job board distribution is not included. **Requires the [`jobsWrite`](authentication#permissions-jobpostingupdate) permission.**
POST /jobPosting.update - Destructive
jobPosting.setCustomFieldValue
> Beta > > This feature is in beta and may not be available for all organizations. Updates one custom field on a job posting. Returns the affected entry, including `value: null` when the field is empty. Identify the field by `fieldId` or `referenceIdentifier`. If both are provided, they must identify the same field. The effective actor must have permission to edit the job that owns the posting. Requires Job Posting custom fields to be enabled; private and API-only field permissions apply. Supports String, LongText, Boolean, Number, Date, ValueSelect, MultiValueSelect and Url fields. Use `null` to clear an optional field; required fields cannot be cleared. Boolean `false` and Number `0` are values, not absences. Multi-select inputs replace the selected values. Omitted fields and unrelated posting properties remain unchanged. Discover definitions with `customField.list`. **Requires the [`jobsWrite`](authentication#permissions-jobpostingsetcustomfieldvalue) permission.**
POST /jobPosting.setCustomFieldValue - Destructive
jobPosting.setCustomFieldValues
> Beta > > This feature is in beta and may not be available for all organizations. Updates a nonempty batch of distinct custom fields on a job posting. Returns the affected entries in request order, including `value: null` for cleared fields. Identify each field by `fieldId` or `referenceIdentifier`. If both are provided, they must identify the same field. A field identified more than once, by either selector, is rejected. The effective actor must have permission to edit the job that owns the posting. Requires Job Posting custom fields to be enabled; private and API-only field permissions apply. Supports String, LongText, Boolean, Number, Date, ValueSelect, MultiValueSelect and Url fields. Use `null` to clear an optional field; required fields cannot be cleared. Boolean `false` and Number `0` are values, not absences. Multi-select inputs replace the selected values. If any submitted value is invalid, no fields are updated. Omitted fields and unrelated posting properties remain unchanged. Discover definitions with `customField.list`. **Requires the [`jobsWrite`](authentication#permissions-jobpostingsetcustomfieldvalues) permission.**
POST /jobPosting.setCustomFieldValues
Job
- Read
job.list
Lists all jobs. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`jobsRead`](authentication#permissions-joblist) permission.**
POST /job.list - Read
job.info
Fetches details of a single job by id. **Requires the [`jobsRead`](authentication#permissions-jobinfo) permission.**
POST /job.info - Read
job.search
Searches jobs by title or custom requisition id. At least one of `title` or `requisitionId` must be provided. **Requires the [`jobsRead`](authentication#permissions-jobsearch) permission.**
POST /job.search - Write
job.create
Creates a new job. **Requires the [`jobsWrite`](authentication#permissions-jobcreate) permission.**
POST /job.create - Write
job.update
Updates an existing job. At least one field other than `jobId` must be supplied. **Requires the [`jobsWrite`](authentication#permissions-jobupdate) permission.**
POST /job.update - Write
job.updateCompensationSettings
Updates compensation display settings for a job. Controls whether and how compensation is shown on job boards and postings for this specific job. Each field uses the null-means-inherit convention: - **Omitted**: leaves the current setting untouched. - **Explicit `null`**: clears the job-level override so the value inherits from the parent brand. - **Any other value**: sets a job-level override. Note: organization-level pay transparency settings (e.g. `globalRequiredOnPostings`) can force compensation display on regardless of these settings. The configured values may therefore differ from the computed display behavior visible to candidates. **Requires the [`jobsWrite`](authentication#permissions-jobupdatecompensationsettings) permission.**
POST /job.updateCompensationSettings - Write
job.setStatus
Sets the status of a job. When setting a job to Closed, you can optionally provide a `closeReasonId` from `closeReason.list`. **Requires the [`jobsWrite`](authentication#permissions-jobsetstatus) permission.**
POST /job.setStatus - Write
job.startApprovalProcess
Starts the approval process for a job. Creates an approval instance and submits it to the configured approvers. If an approval process instance is already pending for the job, returns an error rather than creating a duplicate. **Error codes:** | Code | Description | |---|---| | `insufficient_permissions` | Standard approvals are not available for the organization. | | `job_not_found` | No job exists with the given ID, or the API key cannot access it. | | `approval_process_instance_already_pending` | An approval for this job is already pending. | | `job_approval_definition_not_configured` | No approval definition matches this job. | | `job_cannot_be_opened_due_to_validation` | The job failed approval validation. The `errors` array includes the validation detail. | **Requires the [`approvalsWrite`](authentication#permissions-jobstartapprovalprocess) permission.**
POST /job.startApprovalProcess - Destructive
job.updateCompensation
Replaces the compensation tiers on a job. Pass an empty array to clear existing compensation. **Requires the [`jobsWrite`](authentication#permissions-jobupdatecompensation) permission.**
POST /job.updateCompensation
Job Board
- Read
jobBoard.list
List all enabled job boards. **Requires the [`jobsRead`](authentication#permissions-jobboardlist) permission.**
POST /jobBoard.list
Job Interview Plan
- Read
jobInterviewPlan.info
Returns a job's interview plan, including activities and interviews that need to be scheduled at each stage. **Requires the [`jobsRead`](authentication#permissions-jobinterviewplaninfo) permission.**
POST /jobInterviewPlan.info
Job Template
- Read
jobTemplate.list
List all active and inactive job templates. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`jobsRead`](authentication#permissions-jobtemplatelist) permission.**
POST /jobTemplate.list
Department & Team
- Read
department.info
Fetch department details by id. **Requires the [`organizationRead`](authentication#permissions-departmentinfo) permission.**
POST /department.info - Read
department.list
Lists all departments. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`organizationRead`](authentication#permissions-departmentlist) permission.**
POST /department.list - Write
department.archive
Archives a department. **Requires the [`organizationWrite`](authentication#permissions-departmentarchive) permission.**
POST /department.archive - Write
department.restore
Restores a department. **Requires the [`organizationWrite`](authentication#permissions-departmentrestore) permission.**
POST /department.restore - Write
department.create
Creates a department. **Requires the [`organizationWrite`](authentication#permissions-departmentcreate) permission.**
POST /department.create - Write
department.move
Moves a department to another parent. **Requires the [`organizationWrite`](authentication#permissions-departmentmove) permission.**
POST /department.move - Write
department.update
Updates a department. **Requires the [`organizationWrite`](authentication#permissions-departmentupdate) permission.**
POST /department.update
Location
- Read
location.list
List all locations. Regions are not returned. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`organizationRead`](authentication#permissions-locationlist) permission.**
POST /location.list - Read
location.info
Gets details for a single location by id. **Requires the [`organizationRead`](authentication#permissions-locationinfo) permission.**
POST /location.info - Write
location.archive
Archives a location or location hierarchy. **Requires the [`organizationWrite`](authentication#permissions-locationarchive) permission.**
POST /location.archive - Write
location.create
Creates a location or location hierarchy. **Requires the [`organizationWrite`](authentication#permissions-locationcreate) permission.**
POST /location.create - Write
location.restore
Restores an archived location or location hierarchy. **Requires the [`organizationWrite`](authentication#permissions-locationrestore) permission.**
POST /location.restore - Write
location.move
Moves a location in location hierarchy. **Requires the [`organizationWrite`](authentication#permissions-locationmove) permission.**
POST /location.move - Write
location.updateAddress
Update an address of a location or location hierarchy. **Requires the [`organizationWrite`](authentication#permissions-locationupdateaddress) permission.**
POST /location.updateAddress - Write
location.updateName
Update location's name. **Requires the [`organizationWrite`](authentication#permissions-locationupdatename) permission.**
POST /location.updateName - Write
location.updateWorkplaceType
Update location's workplace type. **Requires the [`organizationWrite`](authentication#permissions-locationupdateworkplacetype) permission.**
POST /location.updateWorkplaceType - Write
location.updateExternalName
Update a location's external (candidate-facing) name. **Requires the [`organizationWrite`](authentication#permissions-locationupdateexternalname) permission.**
POST /location.updateExternalName
Interview Plan
- Read
interviewPlan.list
List published interview plans. Draft interview plans are not returned. If `includeArchived` is true, archived interview plans are also included. Job-specific interview plans are only returned when the caller can read the associated job. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`interviewsRead`](authentication#permissions-interviewplanlist) permission.**
POST /interviewPlan.list
Interview Stage
- Read
interviewStage.list
List all interview stages for an interview plan in order. **Requires the [`interviewsRead`](authentication#permissions-interviewstagelist) permission.**
POST /interviewStage.list - Read
interviewStage.info
Retrieves detailed information about a specific interview stage by its ID. **Requires the [`interviewsRead`](authentication#permissions-interviewstageinfo) permission.**
POST /interviewStage.info
Interview Stage Group
- Read
interviewStageGroup.list
List all interview stage groups in the organization in order. **Requires the [`interviewsRead`](authentication#permissions-interviewstagegrouplist) permission.**
POST /interviewStageGroup.list
Notetaker Transcript
- Read
notetakerTranscript.info
Fetches metadata and a pre-signed download URL for an AI Notetaker transcript recording. **Prerequisites:** - Your organization must have the **AI Notetaker add-on**. If your organization does not have the add-on, requests will fail with the `notetaker_transcript_not_enabled` error. The response includes a signed URL with the transcript JSON. Download the file promptly after calling this endpoint. If the URL has expired, call the endpoint again to get a fresh one. On the free tier, transcripts expire after a retention period. Requesting an expired transcript returns the `notetaker_transcript_expired` error. Organizations with unlimited AI Notetaker access are not subject to this expiry. Use the `notetakerTranscriptId` field from [`interviewEvent.list`](ref:intervieweventlist) or [`interviewSchedule.list`](ref:interviewschedulelist) to discover transcript IDs for interview events. **Error codes:** | Code | Description | |---|---| | `notetaker_transcript_not_enabled` | Your organization does not have the AI Notetaker add-on. | | `notetaker_transcript_not_found` | No transcript exists with the given ID, or you do not have access to it. | | `notetaker_transcript_expired` | The transcript has expired. Upgrade to unlimited AI Notetaker to retain transcripts indefinitely. | | `invalid_input` | The provided `notetakerTranscriptId` is not a valid UUID. | Configure API key permissions in **Admin → API Keys**. See [Managing API Key Permissions](authentication#managing-api-key-permissions). **Requires the [`notetakerRead`](authentication#permissions-notetakertranscriptinfo) permission.**
POST /notetakerTranscript.info
Offer
- Read
offer.list
Get a list of all offers with their latest version. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`offersRead`](authentication#permissions-offerlist) permission.**
POST /offer.list - Read
offer.info
Returns details about a single offer by id. Set `expand.individualSignedPacketDocuments` to true to include file handles for the individual signed documents in an offer packet. **Requires the [`offersRead`](authentication#permissions-offerinfo) permission.**
POST /offer.info - Write
offer.approve
Approves an offer or a specific approval step within an offer's approval process. This endpoint mimics the behavior of the "Force Approve" function in the Ashby app, where an admin can override approval for a specific step or entire approval process. This endpoint can be used in two ways: 1. **Approve entire offer**: Call without `approvalStepId` and `userId` to approve the entire offer approval process 2. **Approve specific step**: Provide both `approvalStepId` and `userId` to approve a specific step in the approval process When approving a specific step, the step must be the current step in the approval process and the user must be an approver for that step. An optional comment can be recorded for a specific-step approval; comments are not supported when approving the entire process. **Requires the [`offersWrite`](authentication#permissions-offerapprove) permission.**
POST /offer.approve - Write
offer.create
Creates a new Offer Offer forms support a variety of field types. The values accepted for each field depend on the type of field that's being filled out: - `Boolean` - A boolean value. - `Currency` - An object in the format `{ currencyCode: "USD", value: 100000 }` where currencyCode is a valid ISO 4217 currency code and value is an integer. - `Date` - A valid ISO Date string. - `Number` - An integer. - `String` - A string. - `ValueSelect` - A string that matches the value of one of the ValueSelect field's selectable options. - `MultiValueSelect` - An array of strings that exist in the MultiValueSelect field's selectable options. **Error codes:** | Code | Description | |---|---| | `opening_in_use` | The opening is already in use by another offer. | | `opening_state_invalid` | The opening has already been closed or filled by a different application.. | **Requires the [`offersWrite`](authentication#permissions-offercreate) permission.**
POST /offer.create - Write
offer.start
The offer.start endpoint creates and returns an offer version instance that can be filled out and submitted using the `offer.create` endpoint. In order to create a new offer version for a candidate with an in-progress offer process, you can call the `offer.start` endpoint and then call the `offer.create` endpoint to fill out the newly created offer version form. **Requires the [`offersWrite`](authentication#permissions-offerstart) permission.**
POST /offer.start - Write
offer.startApprovalProcess
Starts the approval process for an offer in a "WaitingOnApprovalStart" state. Once started, the approval is sent to the configured approvers. The offer version ID can be obtained from the offer (e.g. `offer.info` or `offer.list` response's `latestVersion.id`). **Requires the [`offersWrite`](authentication#permissions-offerstartapprovalprocess) permission.**
POST /offer.startApprovalProcess - Write
offer.update
Updates an existing Offer An Offer custom field submission can identify its field by `path` or `referenceIdentifier`. If both are provided, they must identify the same field. Ordinary form fields require `path`. Offer forms support a variety of field types. The values accepted for each field depend on the type of field that's being filled out: - `Boolean` - A boolean value. - `Currency` - An object in the format `{ currencyCode: "USD", value: 100000 }` where currencyCode is a valid ISO 4217 currency code and value is an integer. - `Date` - A valid ISO Date string. - `Number` - An integer. - `String` - A string. - `ValueSelect` - A string that matches the value of one of the ValueSelect field's selectable options. - `MultiValueSelect` - An array of strings that exist in the MultiValueSelect field's selectable options. Calling this endpoint will create a new version of the offer and retrigger any necessary approval steps. **Requires the [`offersWrite`](authentication#permissions-offerupdate) permission.**
POST /offer.update - Write
offer.setStatus
Updates an offer's acceptance status. Ashby derives the offer status from the provided acceptance status; `offerStatus` can't be set independently. **Requires the [`offersWrite`](authentication#permissions-offersetstatus) permission.**
POST /offer.setStatus - Write
offer.setDecidedAt
Updates an offer's decidedAt timestamp. **Requires the [`offersWrite`](authentication#permissions-offersetdecidedat) permission.**
POST /offer.setDecidedAt - Destructive
offer.reject
Rejects the current step in an offer's approval process. Provide the current approval step and an approver from [`approval.list`](ref:approvallist). Rejecting the step rejects the approval process and cancels the offer. This is distinct from recording that a candidate declined an extended offer, which is handled by [`offer.setStatus`](ref:offersetstatus). **Requires the [`offersWrite`](authentication#permissions-offerreject) permission.**
POST /offer.reject
Offer Process
- Write
offerProcess.start
Starts an offer process for a candidate. **Requires the [`offersWrite`](authentication#permissions-offerprocessstart) permission.**
POST /offerProcess.start
Openings
- Read
opening.info
Retrieves an opening by its UUID. **Requires the [`jobsRead`](authentication#permissions-openinginfo) permission.**
POST /opening.info - Read
opening.list
Lists openings. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`jobsRead`](authentication#permissions-openinglist) permission.**
POST /opening.list - Read
opening.search
Searches for openings by identifier. **Requires the [`jobsRead`](authentication#permissions-openingsearch) permission.**
POST /opening.search - Write
opening.create
Creates an opening. To set values of custom fields on Openings, use the [`customField.setValue`](ref:customfieldsetvalue) endpoint. **Requires the [`jobsWrite`](authentication#permissions-openingcreate) permission.**
POST /opening.create - Write
opening.update
Updates an opening. To set values for custom fields on Openings, use the [`customField.setValue`](ref:customfieldsetvalue) endpoint. **Requires the [`jobsWrite`](authentication#permissions-openingupdate) permission.**
POST /opening.update - Write
opening.setArchived
Sets the archived state of an opening. **Requires the [`jobsWrite`](authentication#permissions-openingsetarchived) permission.**
POST /opening.setArchived - Write
opening.setOpeningState
Sets the state of an opening. **Requires the [`jobsWrite`](authentication#permissions-openingsetopeningstate) permission.**
POST /opening.setOpeningState - Write
opening.addJob
Adds a job to an opening. **Requires the [`jobsWrite`](authentication#permissions-openingaddjob) permission.**
POST /opening.addJob - Write
opening.addLocation
Adds a location to an opening. **Requires the [`jobsWrite`](authentication#permissions-openingaddlocation) permission.**
POST /opening.addLocation - Destructive
opening.removeJob
Removes a job from an opening. **Requires the [`jobsWrite`](authentication#permissions-openingremovejob) permission.**
POST /opening.removeJob - Destructive
opening.removeLocation
Removes a location from an opening. **Requires the [`jobsWrite`](authentication#permissions-openingremovelocation) permission.**
POST /opening.removeLocation
Project
- Read
project.info
Retrieves a project by its UUID. **Requires one of the [`projectsRead`](authentication#permissions-projectinfo) or [`candidatesRead`](authentication#permissions-projectinfo) permissions.**
POST /project.info - Read
project.list
Lists projects. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires one of the [`projectsRead`](authentication#permissions-projectlist) or [`candidatesRead`](authentication#permissions-projectlist) permissions.**
POST /project.list - Read
project.search
Search for projects by title. Responses are limited to 100 results. Consider refining your search or using /project.list to paginate through all projects, if you approach this limit. This API is for use cases where you intend to operate on a final small set of projects, like building a project autocomplete. **Requires one of the [`projectsRead`](authentication#permissions-projectsearch) or [`candidatesRead`](authentication#permissions-projectsearch) permissions.**
POST /project.search - Write
project.create
Creates a project. The effective actor becomes the author, including authorized on-behalf-of requests. Confidential projects are available on Plus, Legacy Plus, and Enterprise plans. Authors retain access to projects they create. Supply initial customFields for every active required Project custom field definition. Hidden, inaccessible, or unsupported required fields prevent creation. Boolean false and Number zero satisfy requiredness. Custom field values require Project custom fields availability; private and API-only field permissions apply. Author assignment is not supported. Omitted optional custom fields remain unset, and the project starts active with no candidates; use separate candidate endpoints to manage membership. **Requires the [`projectsWrite`](authentication#permissions-projectcreate) permission.**
POST /project.create - Write
project.update
Updates a project's title or description, including archived projects. Requires at least one editable field. Omitted fields remain unchanged; null or empty descriptions clear the existing content. The effective actor must have permission to edit the project, including for authorized on-behalf-of requests. Author, confidentiality, archive state, candidate memberships, and custom fields are preserved. Missing historical required custom fields do not block edits. **Requires the [`projectsWrite`](authentication#permissions-projectupdate) permission.**
POST /project.update - Write
project.archive
Archives a project. The effective actor must have permission to edit the project, including authorized on-behalf-of requests. Calling this endpoint on an already archived project succeeds. Candidate memberships, history, authorship, confidentiality, descriptions, and custom-field values are preserved. This endpoint does not permanently delete projects or candidates. **Requires the [`projectsWrite`](authentication#permissions-projectarchive) permission.**
POST /project.archive - Write
project.restore
Restores a project. The effective actor must have permission to edit the project, including authorized on-behalf-of requests. Calling this endpoint on an already active project succeeds. Candidate memberships, history, authorship, confidentiality, descriptions, and custom-field values are preserved. This endpoint does not permanently delete projects or candidates. **Requires the [`projectsWrite`](authentication#permissions-projectrestore) permission.**
POST /project.restore - Destructive
project.setCustomFieldValue
Updates one custom field on a project, including archived projects. Returns the affected entry, including value: null when already empty. The effective actor must have permission to edit the project. Requires Project custom fields availability; private and API-only field permissions apply. Delegated humans may preserve API-only values but cannot change or clear them. Supports the same value types as project.create.customFields. Use null to clear an optional field; required fields cannot be cleared. Boolean false and Number zero satisfy requiredness. Multi-select inputs replace the selected values. Submit configured option values; configured archived options remain valid. Omitted fields and unrelated project properties remain unchanged. Missing historical required fields do not block edits. New User references must identify active, nonservice users in the organization visible to the effective actor; unchanged historical references must still belong to the organization and remain visible. Concurrent writes to the same field use the last completed update. Retrying a request can overwrite a newer value, so avoid concurrent updates to the same project. Definition discovery retains hiringProcessMetadata:read and User discovery retains organization:read. **Requires the [`projectsWrite`](authentication#permissions-projectsetcustomfieldvalue) permission.**
POST /project.setCustomFieldValue - Destructive
project.setCustomFieldValues
Updates a nonempty batch of distinct custom fields on a project, including archived projects. Returns affected entries in request order, including value: null for cleared fields. Duplicate field IDs are rejected. The effective actor must have permission to edit the project. Requires Project custom fields availability; private and API-only field permissions apply. Delegated humans may preserve API-only values but cannot change or clear them. Supports the same value types as project.create.customFields. Use null to clear an optional field; required fields cannot be cleared. Boolean false and Number zero satisfy requiredness. Multi-select inputs replace the selected values. Submit configured option values; configured archived options remain valid. Omitted fields and unrelated project properties remain unchanged. Missing historical required fields do not block edits. New User references must identify active, nonservice users in the organization visible to the effective actor; unchanged historical references must still belong to the organization and remain visible. If any submitted value is invalid, no fields are updated. Concurrent writes to the same field use the last completed update. Retrying a request can overwrite a newer value, so avoid concurrent updates to the same project. Definition discovery retains hiringProcessMetadata:read and User discovery retains organization:read. **Requires the [`projectsWrite`](authentication#permissions-projectsetcustomfieldvalues) permission.**
POST /project.setCustomFieldValues
Source
- Read
source.list
List all sources **Requires the [`hiringProcessMetadataRead`](authentication#permissions-sourcelist) permission.**
POST /source.list
Source Tracking Links
- Read
sourceTrackingLink.list
List all source custom tracking links **Requires the [`hiringProcessMetadataRead`](authentication#permissions-sourcetrackinglinklist) permission.**
POST /sourceTrackingLink.list
Archive Reason
- Read
archiveReason.list
Lists archive reasons. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-archivereasonlist) permission.**
POST /archiveReason.list
Brand
- Read
brand.list
Lists all brands for the organization. **Requires the [`organizationRead`](authentication#permissions-brandlist) permission.**
POST /brand.list
Custom Field
- Read
customField.list
Lists all custom fields. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-customfieldlist) permission.**
POST /customField.list - Read
customField.info
Get information about a custom field. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-customfieldinfo) permission.**
POST /customField.info - Write
customField.create
Create a new custom field. Project custom fields do not support Currency, NumberRange, or CompensationRange. Job and opening custom fields can be configured so their values are editable only through the API when this capability is enabled for the organization. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-customfieldcreate) permission.**
POST /customField.create - Write
customField.setReferenceIdentifier
> Beta > > This feature is in beta and may not be available for all organizations. Assign, change, or remove a custom field's reference ID. Read the current ID with [`customField.info`](https://developers.ashbyhq.com/reference/customfieldinfo) and pass it as `expectedReferenceIdentifier` (`null` if unset). Pass `referenceIdentifier: null` to remove the ID. A removed ID can be reused. If another field holds the ID, `errorInfo.meta.conflictingCustomFieldId` identifies it when this API key can access that field. Management must be enabled for the organization. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-customfieldsetreferenceidentifier) permission.**
POST /customField.setReferenceIdentifier - Write
customField.setValue
Set the value of a custom field for a given object. Pass `fieldValue: null` to clear the custom field. **Note:** To set a custom field on a Job Posting, use [`jobPosting.setCustomFieldValue`](#operation/jobPostingSetCustomFieldValue) instead. **Note:** When updating multiple custom fields on the same object, use [`customField.setValues`](#operation/customFieldSetValues) instead to avoid race conditions. **Note:** To set custom fields on an Employee, use [`user.setCustomFieldValue`](#operation/userSetCustomFieldValue) instead. The values accepted in the `fieldValue` param depend on the type of field that's being updated. See below for more details: - Boolean - A boolean value - Date - An ISO Date string - LongText, String - String - ValueSelect - A string that matches the value of one of the ValueSelect field's options - MultiValueSelect - An array of strings that exist in the MultiValueSelect field's options - Number - A number - Currency - An object with the following properties: - value: A number - currencyCode: A valid ISO 4217 currency code - NumberRange - An object with the following properties: - type: "number-range" - minValue: A number - maxValue: A number - CompensationRange - An object with the following properties: - type: "compensation-range" - minValue: A number - maxValue: A number - currencyCode: A string - interval: A valid interval string - Url - A valid http or https URL (e.g., https://example.com) - UUID - A valid UUID string (e.g., for Employee fields) **Requires the [`candidatesWrite`](authentication#permissions-customfieldsetvalue) permission.**
POST /customField.setValue - Write
customField.setValues
Set the values of multiple custom fields for a given object in a single call. This is the recommended approach when updating multiple fields on the same object to avoid race conditions that can occur with concurrent `customField.setValue` calls. Pass `fieldValue: null` for an entry to clear that custom field. **Note:** To set custom fields on an Employee, use [`user.setCustomFieldValues`](#operation/userSetCustomFieldValues) instead. To set them on a Job Posting, use [`jobPosting.setCustomFieldValues`](#operation/jobPostingSetCustomFieldValues) instead. The values accepted in the `fieldValue` param depend on the type of field that's being updated. See the [`customField.setValue`](#operation/customFieldSetValue) docs for the full per-type table. **Requires the [`candidatesWrite`](authentication#permissions-customfieldsetvalues) permission.**
POST /customField.setValues - Write
customField.updateSelectableValues
Update the selectable values for a custom field. This endpoint merges the provided selectable values with the existing values for a custom field. **Merge behavior:** - **New values** (values not present in the existing values) are added to the field - **Existing values** (matching by `value` field) have their `label` updated and `isArchived` status set from the request - **Omitted values** (existing values not included in the request) are marked as archived - Metadata such as substitution tokens are preserved for existing values The `isArchived` field defaults to `false` if not provided. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-customfieldupdateselectablevalues) permission.**
POST /customField.updateSelectableValues
Assessment
- Write
assessment.update
Update Ashby about the status of a started assessment. `assessment_status` is required unless `cancelled_reason` is provided. **Requires the [`candidatesWrite`](authentication#permissions-assessmentupdate) permission.**
POST /assessment.update - Write
assessment.addCompletedToCandidate
Add a completed assessment to a candidate. **Requires the [`candidatesWrite`](authentication#permissions-assessmentaddcompletedtocandidate) permission.**
POST /assessment.addCompletedToCandidate
Hiring Team
- Write
hiringTeam.addMember
Adds an Ashby user to the hiring team at the application, job, or opening level. **Requires the [`organizationWrite`](authentication#permissions-hiringteamaddmember) permission.**
POST /hiringTeam.addMember - Destructive
hiringTeam.removeMember
Removes an Ashby user from the hiring team at the application, job, or opening level. **Requires the [`organizationWrite`](authentication#permissions-hiringteamremovemember) permission.**
POST /hiringTeam.removeMember
Hiring Team Role
- Read
hiringTeamRole.list
Lists the possible hiring team roles in an organization **Requires the [`organizationRead`](authentication#permissions-hiringteamrolelist) permission.**
POST /hiringTeamRole.list
User
- Read
user.info
Retrieves detailed information about a specific user by their ID. **Requires the [`organizationRead`](authentication#permissions-userinfo) permission.**
POST /user.info - Read
user.list
Lists all users in the organization with pagination support. By default, only active (enabled) users are returned. Use `includeDeactivated: true` to include deactivated users. Supports incremental sync via `syncToken` to efficiently retrieve only users updated since the last sync. **Requires the [`organizationRead`](authentication#permissions-userlist) permission.**
POST /user.list - Read
user.search
Searches for users by email address. Returns an array containing the user if found, or an empty array if no user with the given email exists. **Requires the [`organizationRead`](authentication#permissions-usersearch) permission.**
POST /user.search - Read
user.interviewerSettings
Get interviewer settings for a user. When called with `X-On-Behalf-Of`, the acting user must have permission to administer users unless they are requesting their own data. **Requires the [`organizationRead`](authentication#permissions-userinterviewersettings) permission.**
POST /user.interviewerSettings - Read
user.listInterviewerPauses
Lists all active or scheduled interviewer pauses for a user. When called with `X-On-Behalf-Of`, the acting user must have permission to administer users unless they are requesting their own data. **Requires the [`organizationRead`](authentication#permissions-userlistinterviewerpauses) permission.**
POST /user.listInterviewerPauses - Write
user.updateInterviewerSettings
Update interviewer settings for a user. Either limit can be provided, or both can be provided. If only one is provided, the other will remain unchanged. If a limit is provided but set to null, it will be unset. **Requires the [`organizationWrite`](authentication#permissions-userupdateinterviewersettings) permission.**
POST /user.updateInterviewerSettings - Write
user.createInterviewerPause
Creates an interviewer pause for a user. While paused, the user will not be scheduled for interviews. A user can only have one interviewer pause at a time (whether active or scheduled). Attempting to create a pause when one already exists will return an error. **Requires the [`organizationWrite`](authentication#permissions-usercreateinterviewerpause) permission.**
POST /user.createInterviewerPause - Write
user.setCustomFieldValue
Set the value of a custom field on an employee. The values accepted in the `fieldValue` param depend on the type of field being updated. See the [customField.setValue](https://developers.ashbyhq.com/reference/customfieldsetvalue) docs for accepted types. **Note:** When updating multiple custom fields on the same employee, use [`user.setCustomFieldValues`](#operation/userSetCustomFieldValues) instead to avoid race conditions. **Requires the [`organizationWrite`](authentication#permissions-usersetcustomfieldvalue) permission.**
POST /user.setCustomFieldValue - Write
user.setCustomFieldValues
Set the values of multiple custom fields on an employee in a single call. This is the recommended approach when updating multiple fields on the same employee to avoid race conditions that can occur with concurrent `user.setCustomFieldValue` calls. The values accepted in the `fieldValue` param depend on the type of field being updated. See the [customField.setValue](https://developers.ashbyhq.com/reference/customfieldsetvalue) docs for accepted types. **Requires the [`organizationWrite`](authentication#permissions-usersetcustomfieldvalues) permission.**
POST /user.setCustomFieldValues - Destructive
user.deleteInterviewerPause
Deletes an interviewer pause. **Requires the [`organizationWrite`](authentication#permissions-userdeleteinterviewerpause) permission.**
POST /user.deleteInterviewerPause
Referral
- Read
referral.list
Gets all referral submissions that are visible to the acting user. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`candidatesRead`](authentication#permissions-referrallist) permission.**
POST /referral.list - Write
referral.create
Creates a referral **Requires the [`candidatesWrite`](authentication#permissions-referralcreate) permission.**
POST /referral.create - Destructive
referral.delete
Deletes a referral submission by id. The `referralId` is the `id` returned by [`referral.list`](https://developers.ashbyhq.com/reference/referrallist). The optional `clearAttribution` field controls whether attribution is also removed from the associated application: - `None` is the default and deletes only the referral. - `CreditedToUser` clears the credited user. This is recommended when the employee should no longer see the candidate in their personal Referral dashboard because it preserves Referral as the source for org-level sourcing analytics. - `Source` clears the source. - `All` clears both the credited user and source. Attribution is cleared only when it still belongs to the referral. The credited user must still be the referral's referrer. The source must still be the built-in source for the referral type, which is Referral for direct referrals and Referral Link for social referrals. The response flags report which requested fields were actually cleared. The associated application is not deleted. Restoring the referral within the 7-day restoration window restores only the referral row and does not restore cleared attribution. Returns `referral_not_found` when the referral does not exist or is not visible to the acting user. **Requires the [`candidatesDelete`](authentication#permissions-referraldelete) permission.**
POST /referral.delete
Referral Form
- Write
referralForm.info
Fetches the default referral form or creates a default referral form if none exists. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-referralforminfo) permission.**
POST /referralForm.info
Email Sender
- Read
emailSender.list
Lists the email addresses available to the acting identity for sending email through Ashby. Each result identifies whether the address is primary, a personal alias, an organization alias, or a no-reply address available across the organization's brands. Individual sending endpoints may support only a subset of these sender types. In particular, `sequence.add` always rejects `NoReply` senders; listing an address here does not mean that endpoint accepts it. Without an `X-On-Behalf-Of` header, the acting identity is the API service user, which generally has access to organization-wide and no-reply addresses. Use `X-On-Behalf-Of` to discover the personal addresses available to a specific user. **Requires the [`sourcingRead`](authentication#permissions-emailsenderlist) permission.**
POST /emailSender.list
Sequence
- Read
sequence.info
Retrieves a candidate's sourcing sequence enrollment when it is visible to the acting user. Not-started email stages include resolved, editable subject and HTML body content. Started sequences return stage metadata without message content. Drafts are visible only to the acting user who created them, so requests made with x-on-behalf-of must continue using the same user. Returns sequence_not_found for missing, inaccessible, or non-sourcing sequences. **Requires the [`sourcingRead`](authentication#permissions-sequenceinfo) permission.**
POST /sequence.info - Read
sequence.list
Lists visible started and ended sourcing sequence enrollments across the organization, optionally filtered to one candidate. Results include Running, Paused, Completed, Cancelled, and Unsubscribed sequences; a delayed enrollment is returned as Running. Supports incremental sync. Perform a new full sync after changing the acting identity or its visibility. Changes only to an author's profile do not cause otherwise unchanged enrollments to be returned again. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`sourcingRead`](authentication#permissions-sequencelist) permission.**
POST /sequence.list - Write
sequence.add
Enrolls a candidate in a reusable sourcing sequence. Set start to false to create an editable draft, or true to validate and start the sequence immediately. The optional applicationId fixes the application used for token resolution. The optional from.email must be a Primary, PersonalAlias, or OrganizationAlias address returned by emailSender.list for the same acting user. `NoReply` is never accepted, even when returned by emailSender.list. This excludes both Ashby's no-reply address and custom-domain no-reply addresses sent through Ashby's email infrastructure. Passing any no-reply or otherwise unavailable address returns sequence_sender_not_allowed. Requests made with x-on-behalf-of create a draft owned by that user. If validation errors or required actions block an immediate start, the sequence is returned as NotStarted with a structured Blocked startResult. If a draft already exists for the same candidate, template, and acting user, sequence_draft_already_exists includes its id in errorInfo.meta.existingSequenceId. **Requires the [`sourcingWrite`](authentication#permissions-sequenceadd) permission.**
POST /sequence.add - Write
sequence.start
Validates and starts an existing NotStarted sourcing sequence draft owned by the acting user. Drafts created with x-on-behalf-of must be started with the same acting user. Validation errors and required actions return a structured Blocked startResult and leave the sequence NotStarted and editable. Warnings and informational entries do not block starting. A successful start returns a Started startResult and the sequence's updated status. Returns sequence_not_found for missing, inaccessible, non-sourcing, or already-started sequences. **Requires the [`sourcingWrite`](authentication#permissions-sequencestart) permission.**
POST /sequence.start - Destructive
sequence.cancel
Cancels a running sourcing sequence (campaign) for a candidate. **Requires one of the [`candidatesWrite`](authentication#permissions-sequencecancel) or [`sourcingWrite`](authentication#permissions-sequencecancel) permissions.**
POST /sequence.cancel - Destructive
sequence.discard
Permanently discards a NotStarted sourcing sequence draft owned by the acting user. Drafts created with x-on-behalf-of must be discarded using the same user. Repeating a successful discard is safe. A sequence ID that is absent from the acting organization is treated as already discarded and returns success; this response does not indicate whether the sequence previously existed. Returns sequence_not_found for a sequence that still exists in the acting organization but is inaccessible, belongs to another acting user, or is not a sourcing sequence. A sequence that has already started cannot be discarded and returns invalid_input. **Requires the [`sourcingWrite`](authentication#permissions-sequencediscard) permission.**
POST /sequence.discard - Destructive
sequence.updateStage
Replaces the supplied subject or HTML body of one email stage in a not-started sourcing sequence. At least one of subject or body is required. The reusable sequence template is not changed. Subject is plain text. body uses the rich-text input shape `{ type: "text/html", value: "<p>...</p>" }`. The HTML value may preserve, move, repeat, or remove the Ashby token markers returned by sequence.info or sequence.add. Token identity and final send-time values remain controlled by Ashby; unknown or malformed token markers return invalid_input. Drafts are editable only by the acting user who created them, so requests made with x-on-behalf-of must continue using the same user. Returns sequence_not_found for an inaccessible sequence. **Requires the [`sourcingWrite`](authentication#permissions-sequenceupdatestage) permission.**
POST /sequence.updateStage
Sequence Template
- Read
sequenceTemplate.info
Retrieves metadata for a reusable sourcing sequence template visible to the caller. Archived templates may be returned. Message subjects and bodies are not exposed. Returns sequence_template_not_found when the template does not exist, is not a reusable sourcing template, or is not visible to the caller. **Requires the [`sourcingRead`](authentication#permissions-sequencetemplateinfo) permission.**
POST /sequenceTemplate.info - Read
sequenceTemplate.list
Lists reusable sourcing sequence templates visible to the caller. Returns template and cadence metadata only; message subjects and bodies are not exposed. Archived templates are excluded unless the includeArchived option is true. Use that option when maintaining a complete synchronized catalog. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`sourcingRead`](authentication#permissions-sequencetemplatelist) permission.**
POST /sequenceTemplate.list
Interview Schedule
- Read
interviewSchedule.list
Gets all interview schedules in the organization. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`interviewsRead`](authentication#permissions-interviewschedulelist) permission.**
POST /interviewSchedule.list - Write
interviewSchedule.create
Create a scheduled interview in Ashby. **Requires the [`interviewsWrite`](authentication#permissions-interviewschedulecreate) permission.**
POST /interviewSchedule.create - Destructive
interviewSchedule.update
Update an interview schedule. This endpoint allows you to add, cancel, or update interview events associated with an interview schedule. In order to update an interview event on a schedule, the event's `interviewEventId` must be included when sending your request. `interviewEventId`s are included in the response of the `interviewSchedule.create` endpoint. **Requires the [`interviewsWrite`](authentication#permissions-interviewscheduleupdate) permission.**
POST /interviewSchedule.update - Destructive
interviewSchedule.cancel
Cancel an interview schedule by id. **Requires the [`interviewsWrite`](authentication#permissions-interviewschedulecancel) permission.**
POST /interviewSchedule.cancel
Take Home Assignment
- Read
takeHomeAssignment.list
Lists take-home assignments visible to the caller, including candidate submission metadata and reviewer feedback status, and links each assignment to its interview definition through `interviewId`. Pass `expand: ["interview"]` to include that definition. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`interviewsRead`](authentication#permissions-takehomeassignmentlist) permission.**
POST /takeHomeAssignment.list - Read
takeHomeAssignment.info
Retrieves a single take-home assignment by id and links it to its interview definition through `interviewId`. Pass `expand: ["interview"]` to include that definition. Returns `take_home_assignment_not_found` if the id does not exist or is not visible to the caller. **Requires the [`interviewsRead`](authentication#permissions-takehomeassignmentinfo) permission.**
POST /takeHomeAssignment.info
Interview Event
- Read
interviewEvent.list
Lists interview events associated with an interview schedule. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`interviewsRead`](authentication#permissions-intervieweventlist) permission.**
POST /interviewEvent.list
Interview Briefing
- Read
interviewBriefing.info
Fetch the briefing data for an interview event. Returns the application, interview, per-interviewer status, and the feedback form definition id needed to render an interviewer-facing briefing or to submit feedback via [`applicationFeedback.submit`](applicationfeedbacksubmit). By default, each interviewer in the response is returned as a `userId` with status flags. Pass `expand: ["interviewers"]` to include the full user and pool details for each interviewer. Other expansions return the application, candidate, job, interview, and feedback form definition inline. **Requires the [`interviewsRead`](authentication#permissions-interviewbriefinginfo) permission.**
POST /interviewBriefing.info
Interview
- Read
interview.info
Fetch interview details by id. **Requires the [`interviewsRead`](authentication#permissions-interviewinfo) permission.**
POST /interview.info - Read
interview.list
List all interviews. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`interviewsRead`](authentication#permissions-interviewlist) permission.**
POST /interview.list
File
- Read
file.info
Retrieve the URL for a file referenced by a public API file handle (candidate files, resumes, offer letters, and signature-request files). **Please note** that running this with Ashby-generated demo data in an Ashby demo account can result in errors. We would recommend manually creating a test candidate in Ashby when trying out this endpoint. **Requires the [`candidatesRead`](authentication#permissions-fileinfo) permission.**
POST /file.info - Write
file.createFileUploadHandle
Creates a presigned upload URL that allows uploading a file directly to storage, bypassing the need to send file bytes through the API. The presigned URL expires after 10 minutes. The fileUploadContext must be one of CandidateResume, CandidateFiles, or ApplicationForm. **Requires the [`candidatesWrite`](authentication#permissions-filecreatefileuploadhandle) permission.**
POST /file.createFileUploadHandle
Survey Form Definition
- Read
surveyFormDefinition.info
Returns details about a single survey form definition by id. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-surveyformdefinitioninfo) permission.**
POST /surveyFormDefinition.info - Read
surveyFormDefinition.list
Lists all survey form definitions. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-surveyformdefinitionlist) permission.**
POST /surveyFormDefinition.list
Survey Request
- Read
surveyRequest.list
Lists all survey requests. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`candidatesRead`](authentication#permissions-surveyrequestlist) permission.**
POST /surveyRequest.list - Write
surveyRequest.create
This endpoint generates a survey request and returns a survey URL. You can send this URL to a candidate to allow them to complete a survey. **Note that calling this endpoint will not automatically email the survey to the candidate.** It simply creates the request and gives you a URL to share with a candidate. **Requires the [`candidatesWrite`](authentication#permissions-surveyrequestcreate) permission.**
POST /surveyRequest.create
Survey Submission
- Read
surveySubmission.list
Lists all survey submissions of a given `surveyType`. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`candidatesRead`](authentication#permissions-surveysubmissionlist) permission.**
POST /surveySubmission.list - Write
surveySubmission.create
Creates a survey submission for a candidate and application. **Requires the [`candidatesWrite`](authentication#permissions-surveysubmissioncreate) permission.**
POST /surveySubmission.create
Version
- Read
version.list
Lists available API versions and their lifecycle status. **Callable by any credential; no permission is required.**
POST /version.list
Webhook
- Read
webhook.info
Retrieves information about a specific webhook setting by its ID. **Requires the [`apiKeysRead`](authentication#permissions-webhookinfo) permission.**
POST /webhook.info - Write
webhook.create
Creates a webhook setting. **Requires the [`apiKeysWrite`](authentication#permissions-webhookcreate) permission.**
POST /webhook.create - Write
webhook.update
Updates a webhook setting. One of `enabled`, `requestUrl`, or `secretToken` must be provided. **Requires the [`apiKeysWrite`](authentication#permissions-webhookupdate) permission.**
POST /webhook.update - Destructive
webhook.delete
Deletes a webhook setting. **Requires the [`apiKeysWrite`](authentication#permissions-webhookdelete) permission.**
POST /webhook.delete
Interviewer Pool
- Read
interviewerPool.list
List all interviewer pools. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-interviewerpoollist) permission.**
POST /interviewerPool.list - Read
interviewerPool.info
Get information about an interviewer pool. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-interviewerpoolinfo) permission.**
POST /interviewerPool.info - Write
interviewerPool.archive
Archives an interviewer pool. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolarchive) permission.**
POST /interviewerPool.archive - Write
interviewerPool.restore
Restores an archived interviewer pool. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolrestore) permission.**
POST /interviewerPool.restore - Write
interviewerPool.create
Create an interviewer pool. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolcreate) permission.**
POST /interviewerPool.create - Write
interviewerPool.update
Update an interviewer pool. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolupdate) permission.**
POST /interviewerPool.update - Write
interviewerPool.addUser
Add a user to an interviewer pool. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpooladduser) permission.**
POST /interviewerPool.addUser - Destructive
interviewerPool.removeUser
Remove a user from an interviewer pool. **Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolremoveuser) permission.**
POST /interviewerPool.removeUser
Close Reason
- Read
closeReason.list
Lists all close reasons for jobs or openings. **Requires the [`hiringProcessMetadataRead`](authentication#permissions-closereasonlist) permission.**
POST /closeReason.list
Report
- Read
report.synchronous
Retrieves report data synchronously. **Timeout:** 30 seconds. If a report is timing out, use the asynchronous `report.generate` instead. **Result Style (`resultStyle`):** - `inline` (default): completed report data is embedded in the response under `reportData`, capped at 5MB of uncompressed report data. A completed report above that cap returns `status: "failed"` with `failureReason: "ReportTooLargeForInline"`, and `reportData` carries the `url` shape described below instead of inline `data`/`columnNames`. Request `resultStyle: "url"` to avoid the cap entirely. - `url`: for a completed report, `reportData` contains `url` (a short-lived presigned S3 download URL) and `metadata` instead of the inline `data`/`columnNames`. Use this to download large reports directly from S3 instead of through the API. `includeHeadersInData` must be `true` (or omitted) when `resultStyle` is `url`. - The presigned download is served with `Content-Encoding: br` (Brotli) and no content negotiation, so the client fetching `reportData.url` must decode Brotli. Browsers, `node-fetch`, `curl` installed from `brew`, and Python `requests` with the `brotli`/`brotlicffi` package decode it automatically; stock macOS `curl` and a bare `pip install requests` do not. - For "Show All" reports whose result is a single aggregate count, the response falls back to `inline`: `reportData` contains `data`/`columnNames` and no `url`. Detect the fallback by checking for `reportData.data` with no `reportData.url`. Report types that are not supported by the public API continue to return the standard "not supported" error rather than falling back. **Rate Limiting (Per Organization):** - **Request limit**: 15 requests per minute per organization. - **Concurrent limit**: Maximum 3 report operations at once per organization (shared with `report.generate`). - A report operation holds its concurrency slot for the lifetime of the underlying report build, which can outlast the HTTP request that started it. - Rate limits are shared with `report.generate` for starting new generations. **Usage Notes:** - If you receive a 429 error, your organization has hit its limit - wait briefly and retry. - For long-running reports, use `report.generate` for async processing. **Requires the [`reportsRead`](authentication#permissions-reportsynchronous) permission.**
POST /report.synchronous - Write
report.generate
Generates a new report or polls the status of an existing report generation. **Two-step process:** 1. Call with only `reportId` to start generation and receive a `requestId`. 2. Poll with both `reportId` and `requestId` every second until `status` is `complete` or `failed`. **Result Style (`resultStyle`):** - `inline` (default): completed report data is embedded in the response under `reportData`, capped at 5MB of uncompressed report data. A completed report above that cap returns `status: "failed"` with `failureReason: "ReportTooLargeForInline"`, and `reportData` carries the `url` shape described below instead of inline `data`/`columnNames`. Request `resultStyle: "url"` to avoid the cap entirely. - `url`: for a completed report, `reportData` contains `url` (a short-lived presigned S3 download URL) and `metadata` instead of the inline `data`/`columnNames`. Use this to download large reports directly from S3 instead of through the API. `includeHeadersInData` must be `true` (or omitted) when `resultStyle` is `url`. - Repeat `resultStyle` on every poll (step 2, with `requestId`). The requested style is not stored server-side, so a poll that omits `resultStyle` defaults to `inline` and returns `reportData` even for a report started with `resultStyle: url`. - The presigned download is served with `Content-Encoding: br` (Brotli) and no content negotiation, so the client fetching `reportData.url` must decode Brotli. Browsers, `node-fetch`, `curl` installed from `brew`, and Python `requests` with the `brotli`/`brotlicffi` package decode it automatically; stock macOS `curl` and a bare `pip install requests` do not. - For "Show All" reports whose result is a single aggregate count, the response falls back to `inline`: `reportData` contains `data`/`columnNames` and no `url`. Detect the fallback by checking for `reportData.data` with no `reportData.url`. Report types that are not supported by the public API continue to return the standard "not supported" error rather than falling back. **Rate Limiting (Per Organization):** - **Start generation requests** (without `requestId`): 15 requests per minute per organization. - **Concurrent limit**: Maximum 3 report operations at once per organization (shared with `report.synchronous`). - A report operation holds its concurrency slot for the lifetime of the underlying report build, which can outlast the HTTP request that started it. - **Polling requests** (with `requestId`): Bypass all limits. **Usage Notes:** - If you receive a 429 error, your organization has hit its limit. Wait and retry or use `report.synchronous`. - For synchronous retrieval of existing data, use `report.synchronous`. - Use this async endpoint for reports that may exceed 30 seconds. **Requires the [`reportsRead`](authentication#permissions-reportgenerate) permission.**
POST /report.generate
Approval
- Read
approval.list
Gets all approvals in the organization. You can optionally filter by entity type and entity ID. See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples. **Requires the [`approvalsRead`](authentication#permissions-approvallist) permission.**
POST /approval.list
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 29, 2026. Ashby API docs.