{"openapi":"3.1.0","info":{"version":"1.0.0","title":"Ashby API","description":"The public API for accessing resources in your Ashby instance.","contact":{"name":"Ashby Support","url":"https://app.ashbyhq.com/support","email":"support@ashbyhq.com"}},"servers":[{"url":"https://api.ashbyhq.com"}],"security":[{"BasicAuth":[]}],"tags":[{"name":"ashby","description":"The Ashby API"},{"name":"ApiKey","description":"Operations for managing apikeys"},{"name":"Application","description":"Operations for managing applications"},{"name":"Application Feedback","description":"Operations for managing application feedbacks"},{"name":"Application Feedback Request","description":"Operations for managing application feedback requests"},{"name":"Application Form","description":"Operations for managing application forms"},{"name":"Application Hiring Team Role","description":"Operations for managing application hiring team roles"},{"name":"Approval","description":"Operations for managing approvals"},{"name":"Approval Definition","description":"Operations for managing approval definitions"},{"name":"Archive Reason","description":"Operations for managing archive reasons"},{"name":"Assessment","description":"Operations for managing assessments"},{"name":"Audit Log","description":"Operations for managing audit logs"},{"name":"Brand","description":"Operations for managing brands"},{"name":"Candidate","description":"Operations for managing candidates"},{"name":"Candidate Tag","description":"Operations for managing candidate tags"},{"name":"Close Reason","description":"Operations for managing close reasons"},{"name":"Communication Template","description":"Operations for managing communication templates"},{"name":"Custom Field","description":"Operations for managing custom fields"},{"name":"Department & Team","description":"Operations for managing department & teams"},{"name":"Email Sender","description":"Operations for managing email senders"},{"name":"Feedback Form Definition","description":"Operations for managing feedback form definitions"},{"name":"FeedbackFormDefinition","description":"Operations for managing feedbackformdefinitions"},{"name":"File","description":"Operations for managing files"},{"name":"Hiring Team","description":"Operations for managing hiring teams"},{"name":"Hiring Team Role","description":"Operations for managing hiring team roles"},{"name":"Interview","description":"Operations for managing interviews"},{"name":"Interview Briefing","description":"Operations for managing interview briefings"},{"name":"Interview Event","description":"Operations for managing interview events"},{"name":"Interview Plan","description":"Operations for managing interview plans"},{"name":"Interview Schedule","description":"Operations for managing interview schedules"},{"name":"Interview Stage","description":"Operations for managing interview stages"},{"name":"Interview Stage Group","description":"Operations for managing interview stage groups"},{"name":"Interviewer Pool","description":"Operations for managing interviewer pools"},{"name":"Job","description":"Operations for managing jobs"},{"name":"Job Board","description":"Operations for managing job boards"},{"name":"Job Interview Plan","description":"Operations for managing job interview plans"},{"name":"Job Posting","description":"Operations for managing job postings"},{"name":"Job Template","description":"Operations for managing job templates"},{"name":"Location","description":"Operations for managing locations"},{"name":"Notetaker Transcript","description":"Operations for managing notetaker transcripts"},{"name":"Offer","description":"Operations for managing offers"},{"name":"Offer Process","description":"Operations for managing offer processs"},{"name":"Openings","description":"Operations for managing openingss"},{"name":"Project","description":"Operations for managing projects"},{"name":"Referral","description":"Operations for managing referrals"},{"name":"Referral Form","description":"Operations for managing referral forms"},{"name":"Report","description":"Operations for managing reports"},{"name":"Sequence","description":"Operations for managing sequences"},{"name":"Sequence Template","description":"Operations for managing sequence templates"},{"name":"Source","description":"Operations for managing sources"},{"name":"Source Tracking Links","description":"Operations for managing source tracking linkss"},{"name":"Survey Form Definition","description":"Operations for managing survey form definitions"},{"name":"Survey Request","description":"Operations for managing survey requests"},{"name":"Survey Submission","description":"Operations for managing survey submissions"},{"name":"Take Home Assignment","description":"Operations for managing take home assignments"},{"name":"User","description":"Operations for managing users"},{"name":"Webhook","description":"Operations for managing webhooks"}],"paths":{"/apiKey.info":{"post":{"summary":"apiKey.info","description":"Returns details for the API key used to make the request.\n\n**Requires the [`apiKeysRead`](authentication#permissions-apikeyinfo) permission.**","operationId":"apiKeyInfo","tags":["ApiKey"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyInfoRequest"}}}},"responses":{"200":{"description":"Responses from the apiKey.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"title":"Ashby Automator Bot","createdAt":"2024-01-15T10:30:00.000Z","scopes":["apiKeys:read","candidates:read"]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/auditLog.list":{"post":{"summary":"auditLog.list","description":"> **Beta**\n>\n> **This API is in active development and only available in a closed beta with early design partners.**\n\nLists an organization's audit log entries, newest first. The `targetTypes` and\n`categories` you can filter on are a fixed, code-defined vocabulary; see the\n[Audit Log Vocabulary](/docs/audit-log-vocabulary) guide for valid values and filter examples.\n\n**Pagination:** follow opaque `cursor` / `nextCursor`; see\n[Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync).\n\nReturns audit events for **all** objects in the organization, including confidential jobs\nand projects, with no confidentiality filtering.\n\n**Error codes:**\n\n| Code | Description |\n|---|---|\n| `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. |\n| `audit_logs_not_enabled` | Your organization does not have the Audit Logs feature. |\n| `cursor_invalid` | The provided `cursor` could not be decoded. |\n| `missing_endpoint_permission` | The API key lacks the `auditLogsRead` scope. Returned with HTTP `403`. |\n\n**Requires the [`auditLogsRead`](authentication#permissions-auditloglist) permission.**","operationId":"auditLogList","tags":["Audit Log"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogListRequest"}}}},"responses":{"200":{"description":"Responses from the auditLog.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AuditLogListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.list":{"post":{"summary":"application.list","description":"Gets all applications in the organization.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-applicationlist) permission.**","operationId":"applicationList","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListRequest"}}}},"responses":{"200":{"description":"Responses from the application.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.create":{"post":{"summary":"application.create","description":"Consider a candidate for a job (e.g. when sourcing a candidate for a job posting).\n\nIf 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.\n\nTo set values for custom fields on Applications, use the [`customField.setValue`](ref:customfieldsetvalue) endpoint.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationcreate) permission.**","operationId":"applicationCreate","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCreateRequest"}}}},"responses":{"200":{"description":"Responses from the application.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.update":{"post":{"summary":"application.update","description":"Update an application.\n\nTo set values for custom fields on Applications, use the [`customField.setValue`](ref:customfieldsetvalue) endpoint.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationupdate) permission.**","operationId":"applicationUpdate","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the application.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.delete":{"post":{"summary":"application.delete","description":"Deletes an application by id.\n\n**Requires the [`candidatesDelete`](authentication#permissions-applicationdelete) permission.**","operationId":"applicationDelete","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationDeleteRequest"}}}},"responses":{"200":{"description":"Responses from the application.delete endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationDeleteSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"applicationId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.info":{"post":{"summary":"application.info","description":"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`.\n\n**Requires the [`candidatesRead`](authentication#permissions-applicationinfo) permission.**","operationId":"applicationInfo","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInfoRequest"}}}},"responses":{"200":{"description":"Responses from the application.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.addHiringTeamMember":{"post":{"summary":"application.addHiringTeamMember","description":"Adds an Ashby user to the hiring team at the application level.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationaddhiringteammember) permission.**","operationId":"applicationAddHiringTeamMember","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationAddHiringTeamMemberRequest"}}}},"responses":{"200":{"description":"Responses from the application.addHiringTeamMember endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationAddHiringTeamMemberSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"userId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","firstName":"Joey","lastName":"Joe","email":"joey.joe@example.com","role":"Hiring Manager"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.removeHiringTeamMember":{"post":{"summary":"application.removeHiringTeamMember","description":"Unassigns a hiring team role from an Ashby user at the application level.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationremovehiringteammember) permission.**","operationId":"applicationRemoveHiringTeamMember","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationRemoveHiringTeamMemberRequest"}}}},"responses":{"200":{"description":"Responses from the application.removeHiringTeamMember endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationRemoveHiringTeamMemberSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"userId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","firstName":"Joey","lastName":"Joe","email":"joey.joe@example.com","role":"Hiring Manager"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/applicationHiringTeamRole.list":{"post":{"summary":"applicationHiringTeamRole.list","description":"Gets all available hiring team roles for applications in the organization.\n\n**Requires the [`candidatesRead`](authentication#permissions-applicationhiringteamrolelist) permission.**","operationId":"applicationHiringTeamRoleList","tags":["Application Hiring Team Role"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationHiringTeamRoleListRequest"}}}},"responses":{"200":{"description":"Responses from the applicationHiringTeamRole.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationHiringTeamRoleListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Hiring Manager"}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.change_stage":{"post":{"summary":"application.change_stage","description":"**Deprecated.** Use [`application.changeStage`](ref:applicationchangestage) instead.\n\nChange the stage of an application.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationchange_stage) permission.**","operationId":"applicationChange_stage","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationChangeStageRequest"}}}},"responses":{"200":{"description":"Responses from the application.change_stage endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationChangeStageSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.changeStage":{"post":{"summary":"application.changeStage","description":"Change the stage of an application.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationchangestage) permission.**","operationId":"applicationChangeStage","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationChangeStageRequest"}}}},"responses":{"200":{"description":"Responses from the application.changeStage endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationChangeStageSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.change_source":{"post":{"summary":"application.change_source","description":"**Deprecated.** Use [`application.changeSource`](ref:applicationchangesource) instead.\n\nChange the source of an application.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationchange_source) permission.**","operationId":"applicationChange_source","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationChangeSourceRequest"}}}},"responses":{"200":{"description":"Responses from the application.change_source endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationChangeSourceSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.changeSource":{"post":{"summary":"application.changeSource","description":"Change the source of an application.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationchangesource) permission.**","operationId":"applicationChangeSource","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationChangeSourceRequest"}}}},"responses":{"200":{"description":"Responses from the application.changeSource endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationChangeSourceSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.transfer":{"post":{"summary":"application.transfer","description":"Transfer an application to a different job.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationtransfer) permission.**","operationId":"applicationTransfer","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationTransferRequest"}}}},"responses":{"200":{"description":"Responses from the application.transfer endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationTransferSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.updateHistory":{"post":{"summary":"application.updateHistory","description":"Update the history of an application. Used to update stage timestamps and to delete history events.\n\n**Also requires the `Allow updating application history?` setting found in your admin API key permissions configuration.**\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationupdatehistory) permission.**","operationId":"applicationUpdateHistory","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationUpdateHistoryRequest"}}}},"responses":{"200":{"description":"Responses from the application.updateHistory endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationUpdateHistorySuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.listHistory":{"post":{"summary":"application.listHistory","description":"Fetch a paginated list of application history items for an application.\n\nThis endpoint supports pagination only (not incremental sync). See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-applicationlisthistory) permission.**","operationId":"applicationListHistory","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListHistoryRequest"}}}},"responses":{"200":{"description":"Responses from the application.listHistory endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationListHistorySuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"0d7f1d4e-cdb1-4d72-9c1d-9b1d4d72e0bd","stageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","enteredStageAt":"2024-01-15T10:30:00.000Z","leftStageAt":null,"stageNumber":0,"allowedActions":["delete","set_entered_at"],"actorId":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/application.listCriteriaEvaluations":{"post":{"summary":"application.listCriteriaEvaluations","description":"Fetch a paginated list of AI criteria evaluations for an application.\n\nThis 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.\n\nThis endpoint supports pagination only (not incremental sync). See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for usage examples.\n\n**Note:** This endpoint requires the AI Application Review feature to be enabled for your organization.\n\n**Requires the [`candidatesRead`](authentication#permissions-applicationlistcriteriaevaluations) permission.**","operationId":"applicationListCriteriaEvaluations","tags":["Application"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListCriteriaEvaluationsRequest"}}}},"responses":{"200":{"description":"Responses from the application.listCriteriaEvaluations endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationListCriteriaEvaluationsSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"a4d6d2f0-9b8f-4f0a-8b1a-1f6f7d3c2d1e","criterion":{"id":"9b2cb8d9-1a6b-4d4f-9c5d-69ef7b9a9f12","title":"Location","type":"ResumePrompt","prompt":"Evaluate if the candidate's location aligns with the job requirements.","applicationFormDefinitionId":null,"applicationFormFieldPath":null},"status":"Completed","outcome":"Meets","reasoning":"The candidate's location in San Francisco aligns well with the job's requirement for Bay Area presence.","skipReason":null,"outcomeNumber":0.85,"evaluatedAt":"2024-01-15T10:30:00.000Z"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/applicationFeedback.list":{"post":{"summary":"applicationFeedback.list","description":"List all interview scorecards and feedback submissions associated with an application.\n\nEach feedback submission contains:\n- **formDefinition**: The structure of the feedback form with all available fields\n- **submittedValues**: Responses to the form fields, which depending on the form configuration can include:\n  - Text feedback (e.g., \"Candidate showed strong technical skills...\")\n  - Numerical scores (e.g., \"4\" for a 1-4 rating scale)\n  - 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\n- **Interview context**: Links to associated interviews, events, and the submitting user\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-applicationfeedbacklist) permission.**","operationId":"applicationFeedbackList","tags":["Application Feedback"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationFeedbackListRequest"}}}},"responses":{"200":{"description":"Responses from the applicationFeedback.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationFeedbackListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","applicationId":"550e8400-e29b-41d4-a716-446655440000","feedbackFormDefinitionId":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","interviewId":"6ba7b811-9dad-11d1-80b4-00c04fd430c8","interviewEventId":"6ba7b812-9dad-11d1-80b4-00c04fd430c8","submittedAt":"2023-11-15T14:30:00.000Z","submittedByUser":{"id":"123e4567-e89b-12d3-a456-426614174000","firstName":"Sarah","lastName":"Johnson","email":"sarah.johnson@company.com","globalRole":"Elevated Access","isEnabled":true,"updatedAt":"2023-11-15T14:30:00.000Z"},"creditedToUser":{"id":"3f60c5d3-37bd-44fd-b941-97082c04a496","firstName":"Michael","lastName":"Bluth","email":"michael.bluth@company.com","globalRole":"Limited Access","isEnabled":true,"updatedAt":"2023-11-15T14:30:00.000Z"},"formDefinition":{"sections":[{"title":"Technical Assessment","fields":[{"isRequired":true,"field":{"id":"550e8400-e29b-41d4-a716-446655440001","type":"ValueSelect","path":"overall_recommendation","title":"Overall Recommendation","humanReadablePath":"Overall Recommendation","isNullable":false,"selectableValues":[{"label":"Strong Hire","value":"strong_hire"},{"label":"Hire","value":"hire"},{"label":"No Hire","value":"no_hire"}]}}]}]},"submittedValues":{"overall_recommendation":"hire"}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/applicationFeedback.submit":{"post":{"summary":"applicationFeedback.submit","description":"Application feedback forms support a variety of field types.\n\nThe values accepted for each field depend on the type of field that's being filled out:\n- `Boolean` - A boolean value\n- `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\"`).\n- `Currency` - An object in the format `{ value: 100000, currencyCode: \"USD\" }`. `currencyCode` must be a valid ISO 4217 code.\n- `Date` - A date string in the format YYYY-MM-DD\n- `Email` - A valid email address\n- `LongText`, `Phone`, `String` - A string\n- `MultiValueSelect` - An array of strings that exist in the MultiValueSelect field's selectable options\n- `Number` - An integer\n- `NumberRange` - An object in the format `{ type: \"number-range\", minValue: 1, maxValue: 10 }`\n- `RichText` - We do not support submitting rich text documents via the API but we do support submitting plain text values for these fields. Plain text values must be submitted in the format `{ type: \"PlainText\", value: \"A plain text string\" }`\n- `Score` - An object in the format `{ score: 4 }` where `score` is an integer between 1 and 4 inclusive. Optionally include `comments` as plain text: `{ score: 4, comments: { type: \"PlainText\", value: \"A plain text string\" } }`. Comments are returned in the same PlainText shape in `submittedValues`.\n- `Url` - A valid URL string. The empty string is also accepted.\n- `UUID` - A UUID string, or an object in the format `{ value: \"<uuid>\" }`\n- `ValueSelect` - A string that matches the value of one of the ValueSelect field's selectable options\n\nThe `submittedValues` field in the response contains the submitted feedback in an object where the key is the path of the field and the value is the value submitted for that field.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationfeedbacksubmit) permission.**","operationId":"applicationFeedbackSubmit","tags":["Application Feedback"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationFeedbackSubmitRequest"}}}},"responses":{"200":{"description":"Responses from the applicationFeedback.submit endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationFeedbackSubmitSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"submittedFormInstance":{"id":"0209ec12-0611-4c74-8b86-2cce35acfc46","formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"dbf36925-0161-4f40-8a04-fcb49e5bbdb0","type":"ValueSelect","path":"overall_recommendation","humanReadablePath":"Overall Recommendation","title":"Overall Recommendation","isNullable":false,"selectableValues":[{"label":"4 - Strong Yes","value":"4"},{"label":"3 - Yes","value":"3"},{"label":"2 - No","value":"2"},{"label":"1 - Strong No","value":"1"}]}}]}]},"submittedValues":{"overall_recommendation":"3"}}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/applicationFeedbackRequest.create":{"post":{"summary":"applicationFeedbackRequest.create","description":"Request feedback on an application without scheduling an interview.\nThe `interviewEventId` returned in the response can be provided to `applicationFeedback.submit` to\ncomplete the feedback request.\n\nThe interview used must be configured to request feedback.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationfeedbackrequestcreate) permission.**","operationId":"applicationFeedbackRequestCreate","tags":["Application Feedback Request"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationFeedbackRequestCreateRequest"}}}},"responses":{"200":{"description":"Responses from the applicationFeedbackRequest.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationFeedbackRequestCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"interviewEventId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","interviewerUserId":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","applicationId":"550e8400-e29b-41d4-a716-446655440000"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/applicationForm.submit":{"post":{"summary":"applicationForm.submit","description":"Submits a completed application form for a job posting.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationformsubmit) permission.**","operationId":"applicationFormSubmit","tags":["Application Form"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationFormSubmitRequest"}}}},"responses":{"200":{"description":"Responses from the applicationForm.submit endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApplicationFormSubmitSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"submittedFormInstance":{"id":"7a3d9986-a88a-49f4-b363-8da21b893e30","formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"e7a0d858-963f-4964-b268-5271ad20dd59","type":"String","path":"_systemfield_name","humanReadablePath":"Name","title":"Name","isNullable":false}}]}]},"submittedValues":{"_systemfield_name":"Zod Baseline Applicant"}},"formMessages":{"blocked":false}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/approvalDefinition.update":{"post":{"summary":"approvalDefinition.update","description":"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.\n\nIf the provided approval step definitions is an empty list, then approval will be skipped and the entity will proceed to the next stage.\n\n**Requires the [`approvalsWrite`](authentication#permissions-approvaldefinitionupdate) permission.**","operationId":"approvalDefinitionUpdate","tags":["Approval Definition"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalDefinitionUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the approvalDefinition.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApprovalDefinitionUpdateResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"a4664a1d-b140-4da8-9a65-6efb8723f223","entityType":"Offer","entityId":"e78fffa1-6431-436f-a21a-004891b47ac5","approvalSteps":[{"approvalsRequired":1,"approvers":[{"type":"user","userId":"aa256a6b-2d2a-4a42-aed5-a94321a4e180"}]}]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.list":{"post":{"summary":"candidate.list","description":"Lists all candidates in the organization with pagination and incremental sync support.\n\nUse the `syncToken` parameter to retrieve only candidates updated since your last sync.\nUse `createdAfter` to filter candidates by creation date.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidatelist) permission.**","operationId":"candidateList","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateListRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.search":{"post":{"summary":"candidate.search","description":"Searches for candidates by email and/or name.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidatesearch) permission.**","operationId":"candidateSearch","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateSearchRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateSearchSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.info":{"post":{"summary":"candidate.info","description":"Fetches details about a single candidate by id or external mapping id.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidateinfo) permission.**","operationId":"candidateInfo","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateInfoRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.create":{"post":{"summary":"candidate.create","description":"Creates a new candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidatecreate) permission.**","operationId":"candidateCreate","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateCreateRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.uploadResume":{"post":{"summary":"candidate.uploadResume","description":"Uploads a resume for a candidate. Accepts either a multipart/form-data\nrequest with a `resume` file part, or a JSON body with a `resumeHandle`\npreviously created via `file.createFileUploadHandle`.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateuploadresume) permission.**","operationId":"candidateUploadResume","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateUploadResumeRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.uploadResume endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateUploadResumeSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.uploadFile":{"post":{"summary":"candidate.uploadFile","description":"Uploads a file for a candidate. Accepts either a multipart/form-data\nrequest with a `file` file part, or a JSON body with a `fileHandle`\npreviously created via `file.createFileUploadHandle`.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateuploadfile) permission.**","operationId":"candidateUploadFile","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateUploadFileRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.uploadFile endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateUploadFileSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.update":{"post":{"summary":"candidate.update","description":"Updates an existing candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateupdate) permission.**","operationId":"candidateUpdate","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.createNote":{"post":{"summary":"candidate.createNote","description":"Creates a note on a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidatecreatenote) permission.**","operationId":"candidateCreateNote","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateCreateNoteRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.createNote endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateCreateNoteSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"5fa61e0b-3c4d-4e5f-9a0b-1c2d3e4f5a6b","createdAt":"2024-01-15T10:30:00.000Z","isPrivate":false,"content":"Strong candidate, very interested in the company","author":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","firstName":"George","lastName":"Bluth","email":"george@bluth.example"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.listClientInfo":{"post":{"summary":"candidate.listClientInfo","description":"Lists client information records (IP, user agent) collected for a candidate.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidatelistclientinfo) permission.**","operationId":"candidateListClientInfo","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateListClientInfoRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.listClientInfo endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateListClientInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"7d31034c-790b-4265-bf63-d65396d59d0b","ipAddress":"86.234.23.243","userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36","relatedEntityType":"application","relatedEntityId":"57133f77-9362-4397-b395-03bda1f72303","candidateId":"9d22854f-c929-4b86-9f42-cb71cc0e4fc7","createdAt":"2024-01-15T10:30:00.000Z"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.listFraudChecks":{"post":{"summary":"candidate.listFraudChecks","description":"Lists the fraud checks performed on a candidate.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidatelistfraudchecks) permission.**","operationId":"candidateListFraudChecks","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateListFraudChecksRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.listFraudChecks endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateListFraudChecksSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"f5b1e9a2-3c4d-4e5f-9a0b-1c2d3e4f5a6b","candidateId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applicationId":null,"createdAt":"2025-01-15T10:30:00.000Z","fraudSignals":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.setFraudStatus":{"post":{"summary":"candidate.setFraudStatus","description":"Updates the manual fraud-review status of a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidatesetfraudstatus) permission.**","operationId":"candidateSetFraudStatus","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateSetFraudStatusRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.setFraudStatus endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateSetFraudStatusSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.listNotes":{"post":{"summary":"candidate.listNotes","description":"Lists the notes that have been added to a candidate.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidatelistnotes) permission.**","operationId":"candidateListNotes","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateListNotesRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.listNotes endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateListNotesSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"5fa61e0b-3c4d-4e5f-9a0b-1c2d3e4f5a6b","createdAt":"2024-01-15T10:30:00.000Z","isPrivate":false,"content":"Strong candidate, very interested in the company","author":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","firstName":"George","lastName":"Bluth","email":"george@bluth.example"}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.anonymize":{"post":{"summary":"candidate.anonymize","description":"Anonymizes a candidate's personally identifiable information.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateanonymize) permission.**","operationId":"candidateAnonymize","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateAnonymizeRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.anonymize endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateAnonymizeSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.removeProject":{"post":{"summary":"candidate.removeProject","description":"Removes the candidate from a project.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateremoveproject) permission.**","operationId":"candidateRemoveProject","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateRemoveProjectRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.removeProject endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateRemoveProjectSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.addProject":{"post":{"summary":"candidate.addProject","description":"Adds a candidate to a project.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateaddproject) permission.**","operationId":"candidateAddProject","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateAddProjectRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.addProject endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateAddProjectSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.addEmailMessage":{"post":{"summary":"candidate.addEmailMessage","description":"Attaches an existing email message (e.g. fetched from a partner provider) to a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateaddemailmessage) permission.**","operationId":"candidateAddEmailMessage","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateAddEmailMessageRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.addEmailMessage endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateAddEmailMessageSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"9d8eb6b1-9b6f-4c9d-9c1e-5a07f9b4f9c0","candidateId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","emailProviderEmailId":"msg-12345","subject":"Re: Application","from":"recruiter@example.com","to":"adam.hart@example.com","body":"<p>Thanks for applying!</p>","sentAt":"2024-01-15T10:30:00.000Z","cc":null,"messageUrl":null,"messageIdHeader":null,"threadId":"msg-12345","isPrivate":false,"userIsSender":true}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.addTag":{"post":{"summary":"candidate.addTag","description":"Adds a tag to a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateaddtag) permission.**","operationId":"candidateAddTag","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateAddTagRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.addTag endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateAddTagSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.removeTag":{"post":{"summary":"candidate.removeTag","description":"Removes a tag from a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateremovetag) permission.**","operationId":"candidateRemoveTag","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateRemoveTagRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.removeTag endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateRemoveTagSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.listProjects":{"post":{"summary":"candidate.listProjects","description":"Lists the projects a candidate has been added to.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidatelistprojects) permission.**","operationId":"candidateListProjects","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateListProjectsRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.listProjects endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateListProjectsSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"bcffca12-5b09-4a76-acf2-00a8e267b222","createdAt":"2024-01-15T10:30:00.000Z","title":"Senior Engineers","isArchived":false,"authorId":"7211e226-7802-41fd-8d55-2720fe9d534f","description":"Project for sourcing senior engineers","confidential":false,"customFieldEntries":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidate.pushToHris":{"post":{"summary":"candidate.pushToHris","description":"> Beta\n>\n> This feature is in beta and may not be available for all organizations.\n\nPushes a candidate's data to an HRIS system (e.g. Workday, BambooHR, ADP).\n\nThis endpoint triggers the \"Add Candidate Data\" flow for the specified application\nand HRIS system. The candidate must have a name, and any offer associated with\nthe application must be in an accepted state (for systems that require it) before\npushing.\n\nIf the candidate has already been pushed to the same system, the push will be\nretried automatically. For SelfServe integrations, `integrationPartnerId` is\nrequired.\n\n**Error codes:**\n\n| Code | Description |\n|---|---|\n| `candidate_hris_push_blocked_by_offer_status` | The candidate's offer is not in a state that permits pushing to this HRIS. |\n| `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. |\n\n> Retries\n>\n> A `generic_internal_error` response does not guarantee the push did not occur — the\n> candidate mapping and downstream events may already have been created. Do not blindly\n> retry on this error; check whether the candidate was already pushed first to avoid\n> duplicate pushes.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidatepushtohris) permission.**","operationId":"candidatePushToHris","tags":["Candidate"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidatePushToHrisRequest"}}}},"responses":{"200":{"description":"Responses from the candidate.pushToHris endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidatePushToHrisSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"f1a2b3c4-d5e6-7890-abcd-ef1234567890","candidateId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applicationId":"f9e52a51-a075-4116-a7b8-484deba69004","externalId":"WD-12345","externalSystem":"Workday","createdAt":"2024-01-15T10:30:00.000Z"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidateTag.create":{"post":{"summary":"candidateTag.create","description":"Creates a candidate tag.\n\nIf a tag already exists with the given title, the existing tag will be returned.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-candidatetagcreate) permission.**","operationId":"candidateTagCreate","tags":["Candidate Tag"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateTagCreateRequest"}}}},"responses":{"200":{"description":"Responses from the candidateTag.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateTagCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Strong candidate","isArchived":false}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidateTag.archive":{"post":{"summary":"candidateTag.archive","description":"Archives a candidate tag.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-candidatetagarchive) permission.**","operationId":"candidateTagArchive","tags":["Candidate Tag"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateTagArchiveRequest"}}}},"responses":{"200":{"description":"Responses from the candidateTag.archive endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateTagArchiveSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Strong candidate","isArchived":true}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/candidateTag.list":{"post":{"summary":"candidateTag.list","description":"Lists all candidate tags.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-candidatetaglist) permission.**","operationId":"candidateTagList","tags":["Candidate Tag"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidateTagListRequest"}}}},"responses":{"200":{"description":"Responses from the candidateTag.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CandidateTagListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Strong candidate","isArchived":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/communicationTemplate.list":{"post":{"summary":"communicationTemplate.list","description":"List all enabled communication templates.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-communicationtemplatelist) permission.**","operationId":"communicationTemplateList","tags":["Communication Template"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommunicationTemplateListRequest"}}}},"responses":{"200":{"description":"Responses from the communicationTemplate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CommunicationTemplateListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","title":"Rejection + Consideration for Future Positions","intendedTypes":["email","inMail"]}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/feedbackFormDefinition.list":{"post":{"summary":"feedbackFormDefinition.list","description":"Lists all feedback form definitions.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-feedbackformdefinitionlist) permission.**","operationId":"feedbackFormDefinitionList","tags":["FeedbackFormDefinition"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackFormDefinitionListRequest"}}}},"responses":{"200":{"description":"Responses from the feedbackFormDefinition.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/FeedbackFormDefinitionListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"c56d8409-8846-44a7-b09e-8959154bcf17","organizationId":"ec647f56-f27a-49a1-84af-021ad0a19f21","title":"Default Feedback Form","isArchived":false,"isDefaultForm":true,"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"dbf36925-0161-4f40-8a04-fcb49e5bbdb0","type":"ValueSelect","path":"overall_recommendation","humanReadablePath":"Overall Recommendation","title":"Overall Recommendation","isNullable":false,"selectableValues":[{"label":"4 - Strong Yes","value":"4"},{"label":"3 - Yes","value":"3"}]}}]}]},"interviewId":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/feedbackFormDefinition.info":{"post":{"summary":"feedbackFormDefinition.info","description":"Returns a single feedback form by id\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-feedbackformdefinitioninfo) permission.**","operationId":"feedbackFormDefinitionInfo","tags":["Feedback Form Definition"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackFormDefinitionInfoRequest"}}}},"responses":{"200":{"description":"Responses from the feedbackFormDefinition.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/FeedbackFormDefinitionInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"c56d8409-8846-44a7-b09e-8959154bcf17","organizationId":"ec647f56-f27a-49a1-84af-021ad0a19f21","title":"Default Feedback Form","isArchived":false,"isDefaultForm":true,"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"dbf36925-0161-4f40-8a04-fcb49e5bbdb0","type":"ValueSelect","path":"overall_recommendation","humanReadablePath":"Overall Recommendation","title":"Overall Recommendation","isNullable":false,"selectableValues":[{"label":"4 - Strong Yes","value":"4"},{"label":"3 - Yes","value":"3"}]}}]}]},"interviewId":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/jobPosting.list":{"post":{"summary":"jobPosting.list","description":"Lists published job postings. By default, only published job postings are returned.\n\nSet `includeUnpublishedJobPostings` to `true` to also include unpublished (draft) job postings.\n\n**Important**: By default, this endpoint includes all listed and unlisted job postings. Unlisted job postings should not be displayed publicly.\nIf 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.\n\n**Requires the [`jobsRead`](authentication#permissions-jobpostinglist) permission.**","operationId":"jobPostingList","tags":["Job Posting"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobPostingListRequest"}}}},"responses":{"200":{"description":"Responses from the jobPosting.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobPostingListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","jobId":"8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d","departmentName":"Engineering","teamName":"Product Engineering","locationName":"San Francisco","locationIds":{"primaryLocationId":"7bb8f10f-12d0-4d26-8d08-0f432a67b123","secondaryLocationIds":[]},"workplaceType":"OnSite","employmentType":"FullTime","isListed":true,"publishedDate":"2024-01-15","applicationDeadline":null,"externalLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applyLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","compensationTierSummary":"$100K - $120K","shouldDisplayCompensationOnJobBoard":true,"updatedAt":"2024-01-15T10:30:00.000Z"}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/jobPosting.info":{"post":{"summary":"jobPosting.info","description":"Retrieve an individual job posting.\n\nSet `includeUnpublishedJobPostings` to `true` when fetching an unpublished (draft) job posting. This flag is required for draft postings; published postings can be fetched without it.\n\nResult fields:\n- `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).\n- `applicationFormDefinition` - See the guide on [Creating a custom careers page](https://developers.ashbyhq.com/docs/creating-a-custom-careers-page).\n\n**Requires the [`jobsRead`](authentication#permissions-jobpostinginfo) permission.**","operationId":"jobPostingInfo","tags":["Job Posting"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobPostingInfoRequest"}}}},"responses":{"200":{"description":"Responses from the jobPosting.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobPostingInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","descriptionPlain":"This role will build and maintain customer-facing software.","descriptionHtml":"<p>This role will build and maintain customer-facing software.</p>","descriptionSocial":null,"descriptionParts":{"descriptionOpening":null,"descriptionBody":{"html":"<p>This role will build and maintain customer-facing software.</p>","plain":"This role will build and maintain customer-facing software."},"descriptionClosing":null},"departmentName":"Engineering","teamName":"Product Engineering","teamNameHierarchy":["Engineering","Product Engineering"],"jobId":"8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d","locationName":"San Francisco","locationAddress":"San Francisco, California, United States","locationIds":{"primaryLocationId":"7bb8f10f-12d0-4d26-8d08-0f432a67b123","secondaryLocationIds":[]},"linkedData":{},"publishedDate":"2024-01-15","applicationDeadline":null,"address":{"postalAddress":{"addressRegion":"California","addressCountry":"United States","addressLocality":"San Francisco"}},"isRemote":false,"workplaceType":"OnSite","employmentType":"FullTime","applicationFormDefinition":{},"surveyFormDefinitions":[],"isListed":true,"suppressDescriptionOpening":false,"suppressDescriptionClosing":false,"externalLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applyLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","compensation":{"compensationTierSummary":"$100K - $120K","summaryComponents":[{"summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}],"compensationTiers":[{"id":"7acaf4b2-fbd2-47f9-8d09-222a3a469da1","tierSummary":"$100K - $120K","title":null,"additionalInformation":null,"components":[{"id":"e58d5b1e-6fc7-4df4-a418-e4f746235db7","summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}]}],"shouldDisplayCompensation":true},"updatedAt":"2024-01-15T10:30:00.000Z","applicationLimitCalloutHtml":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/jobPosting.updateCompensation":{"post":{"summary":"jobPosting.updateCompensation","description":"Updates compensation for an existing job posting.\n\nSet `includeUnpublishedJobPostings` to `true` when updating an unpublished (draft) job posting. This flag is required for draft postings; published postings can be updated without it.\n\nPass 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.\n\n**Requires the [`jobsWrite`](authentication#permissions-jobpostingupdatecompensation) permission.**","operationId":"jobPostingUpdateCompensation","tags":["Job Posting"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobPostingUpdateCompensationRequest"}}}},"responses":{"200":{"description":"Responses from the jobPosting.updateCompensation endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobPostingUpdateCompensationSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","descriptionPlain":"This role will build and maintain customer-facing software.","descriptionHtml":"<p>This role will build and maintain customer-facing software.</p>","descriptionSocial":null,"descriptionParts":{"descriptionOpening":null,"descriptionBody":{"html":"<p>This role will build and maintain customer-facing software.</p>","plain":"This role will build and maintain customer-facing software."},"descriptionClosing":null},"departmentName":"Engineering","teamName":"Product Engineering","teamNameHierarchy":["Engineering","Product Engineering"],"jobId":"8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d","locationName":"San Francisco","locationAddress":"San Francisco, California, United States","locationIds":{"primaryLocationId":"7bb8f10f-12d0-4d26-8d08-0f432a67b123","secondaryLocationIds":[]},"linkedData":{},"publishedDate":"2024-01-15","applicationDeadline":null,"address":{"postalAddress":{"addressRegion":"California","addressCountry":"United States","addressLocality":"San Francisco"}},"isRemote":false,"workplaceType":"OnSite","employmentType":"FullTime","applicationFormDefinition":{},"surveyFormDefinitions":[],"isListed":true,"suppressDescriptionOpening":false,"suppressDescriptionClosing":false,"externalLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applyLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","compensation":{"compensationTierSummary":"$100K - $120K","summaryComponents":[{"summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}],"compensationTiers":[{"id":"7acaf4b2-fbd2-47f9-8d09-222a3a469da1","tierSummary":"$100K - $120K","title":null,"additionalInformation":null,"components":[{"id":"e58d5b1e-6fc7-4df4-a418-e4f746235db7","summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}]}],"shouldDisplayCompensation":true},"updatedAt":"2024-01-15T10:30:00.000Z","applicationLimitCalloutHtml":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/jobPosting.update":{"post":{"summary":"jobPosting.update","description":"Updates an existing job posting.\n\nSet `includeUnpublishedJobPostings` to `true` when updating an unpublished (draft) job posting. This flag is required for draft postings; published postings can be updated without it.\n\n**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.\n\n**Requires the [`jobsWrite`](authentication#permissions-jobpostingupdate) permission.**","operationId":"jobPostingUpdate","tags":["Job Posting"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobPostingUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the jobPosting.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobPostingUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","descriptionPlain":"This role will build and maintain customer-facing software.","descriptionHtml":"<p>This role will build and maintain customer-facing software.</p>","descriptionSocial":null,"descriptionParts":{"descriptionOpening":null,"descriptionBody":{"html":"<p>This role will build and maintain customer-facing software.</p>","plain":"This role will build and maintain customer-facing software."},"descriptionClosing":null},"departmentName":"Engineering","teamName":"Product Engineering","teamNameHierarchy":["Engineering","Product Engineering"],"jobId":"8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d","locationName":"San Francisco","locationAddress":"San Francisco, California, United States","locationIds":{"primaryLocationId":"7bb8f10f-12d0-4d26-8d08-0f432a67b123","secondaryLocationIds":[]},"linkedData":{},"publishedDate":"2024-01-15","applicationDeadline":null,"address":{"postalAddress":{"addressRegion":"California","addressCountry":"United States","addressLocality":"San Francisco"}},"isRemote":false,"workplaceType":"OnSite","employmentType":"FullTime","applicationFormDefinition":{},"surveyFormDefinitions":[],"isListed":true,"suppressDescriptionOpening":false,"suppressDescriptionClosing":false,"externalLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applyLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","compensation":{"compensationTierSummary":"$100K - $120K","summaryComponents":[{"summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}],"compensationTiers":[{"id":"7acaf4b2-fbd2-47f9-8d09-222a3a469da1","tierSummary":"$100K - $120K","title":null,"additionalInformation":null,"components":[{"id":"e58d5b1e-6fc7-4df4-a418-e4f746235db7","summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}]}],"shouldDisplayCompensation":true},"updatedAt":"2024-01-15T10:30:00.000Z","applicationLimitCalloutHtml":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/job.list":{"post":{"summary":"job.list","description":"Lists all jobs.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`jobsRead`](authentication#permissions-joblist) permission.**","operationId":"jobList","tags":["Job"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobListRequest"}}}},"responses":{"200":{"description":"Responses from the job.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/job.info":{"post":{"summary":"job.info","description":"Fetches details of a single job by id.\n\n**Requires the [`jobsRead`](authentication#permissions-jobinfo) permission.**","operationId":"jobInfo","tags":["Job"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobInfoRequest"}}}},"responses":{"200":{"description":"Responses from the job.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/job.create":{"post":{"summary":"job.create","description":"Creates a new job.\n\n**Requires the [`jobsWrite`](authentication#permissions-jobcreate) permission.**","operationId":"jobCreate","tags":["Job"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCreateRequest"}}}},"responses":{"200":{"description":"Responses from the job.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Draft","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":null,"closedAt":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/job.update":{"post":{"summary":"job.update","description":"Updates an existing job. At least one field other than `jobId` must be supplied.\n\n**Requires the [`jobsWrite`](authentication#permissions-jobupdate) permission.**","operationId":"jobUpdate","tags":["Job"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the job.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/job.updateCompensation":{"post":{"summary":"job.updateCompensation","description":"Replaces the compensation tiers on a job. Pass an empty array to clear existing compensation.\n\n**Requires the [`jobsWrite`](authentication#permissions-jobupdatecompensation) permission.**","operationId":"jobUpdateCompensation","tags":["Job"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobUpdateCompensationRequest"}}}},"responses":{"200":{"description":"Responses from the job.updateCompensation endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobUpdateCompensationSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/job.search":{"post":{"summary":"job.search","description":"Searches jobs by title or custom requisition id. At least one of `title` or `requisitionId` must be provided.\n\n**Requires the [`jobsRead`](authentication#permissions-jobsearch) permission.**","operationId":"jobSearch","tags":["Job"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSearchRequest"}}}},"responses":{"200":{"description":"Responses from the job.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobSearchSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/job.setStatus":{"post":{"summary":"job.setStatus","description":"Sets the status of a job.\n\n**Requires the [`jobsWrite`](authentication#permissions-jobsetstatus) permission.**","operationId":"jobSetStatus","tags":["Job"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSetStatusRequest"}}}},"responses":{"200":{"description":"Responses from the job.setStatus endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobSetStatusSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/jobBoard.list":{"post":{"summary":"jobBoard.list","description":"List all enabled job boards.\n\n**Requires the [`jobsRead`](authentication#permissions-jobboardlist) permission.**","operationId":"jobBoardList","tags":["Job Board"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobBoardListRequest"}}}},"responses":{"200":{"description":"Responses from the jobBoard.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobBoardListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"ce033f37-9f24-4f6d-8b7f-1d8a3d7c0a2b","title":"Acme Careers","isInternal":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/jobInterviewPlan.info":{"post":{"summary":"jobInterviewPlan.info","description":"Returns a job's interview plan, including activities and interviews that need to be scheduled at each stage.\n\n**Requires the [`jobsRead`](authentication#permissions-jobinterviewplaninfo) permission.**","operationId":"jobInterviewPlanInfo","tags":["Job Interview Plan"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobInterviewPlanInfoRequest"}}}},"responses":{"200":{"description":"Responses from the jobInterviewPlan.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobInterviewPlanInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"jobId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","interviewPlanId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","stages":[{"id":"8d4f4ef3-1b59-4f8b-bd23-69d4e2dc8af8","title":"Recruiter Phone Screen","type":"Active","orderInInterviewPlan":4,"activities":[{"id":"f1c1b9b7-bf95-4f2a-bbf4-2c7d3b8e1aaa","title":"Interview stage template","interviews":[{"id":"9bcec74e-2c1a-4ad1-8cda-f5b9a4f12bb2","title":"Recruiter Phone Call","interviewId":"f44eecb7-7a73-4cf4-a3ba-1f8da9d2d8e1","interviewDurationMinutes":60,"isSchedulable":true}]}]}]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/jobTemplate.list":{"post":{"summary":"jobTemplate.list","description":"List all active and inactive job templates.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`jobsRead`](authentication#permissions-jobtemplatelist) permission.**","operationId":"jobTemplateList","tags":["Job Template"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobTemplateListRequest"}}}},"responses":{"200":{"description":"Responses from the jobTemplate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobTemplateListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","status":"Active","locationId":"b9b9b9b9-b9b9-4b9b-b9b9-b9b9b9b9b9b9","departmentId":"c8c8c8c8-c8c8-4c8c-c8c8-c8c8c8c8c8c8","defaultInterviewPlanId":"d7d7d7d7-d7d7-4d7d-d7d7-d7d7d7d7d7d7","interviewPlanIds":["d7d7d7d7-d7d7-4d7d-d7d7-d7d7d7d7d7d7"],"createdAt":"2022-08-12T20:29:56.964Z","updatedAt":"2023-09-13T21:30:57.965Z"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/department.archive":{"post":{"summary":"department.archive","description":"Archives a department.\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentarchive) permission.**","operationId":"departmentArchive","tags":["Department & Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentArchiveRequest"}}}},"responses":{"200":{"description":"Responses from the department.archive endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DepartmentArchiveSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":true,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/department.restore":{"post":{"summary":"department.restore","description":"Restores a department.\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentrestore) permission.**","operationId":"departmentRestore","tags":["Department & Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentRestoreRequest"}}}},"responses":{"200":{"description":"Responses from the department.restore endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DepartmentRestoreSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/department.create":{"post":{"summary":"department.create","description":"Creates a department.\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentcreate) permission.**","operationId":"departmentCreate","tags":["Department & Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentCreateRequest"}}}},"responses":{"200":{"description":"Responses from the department.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DepartmentCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/department.info":{"post":{"summary":"department.info","description":"Fetch department details by id.\n\n**Requires the [`organizationRead`](authentication#permissions-departmentinfo) permission.**","operationId":"departmentInfo","tags":["Department & Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentInfoRequest"}}}},"responses":{"200":{"description":"Responses from the department.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DepartmentInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/department.list":{"post":{"summary":"department.list","description":"Lists all departments.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`organizationRead`](authentication#permissions-departmentlist) permission.**","operationId":"departmentList","tags":["Department & Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentListRequest"}}}},"responses":{"200":{"description":"Responses from the department.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DepartmentListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/department.move":{"post":{"summary":"department.move","description":"Moves a department to another parent.\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentmove) permission.**","operationId":"departmentMove","tags":["Department & Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentMoveRequest"}}}},"responses":{"200":{"description":"Responses from the department.move endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DepartmentMoveSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/department.update":{"post":{"summary":"department.update","description":"Updates a department.\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentupdate) permission.**","operationId":"departmentUpdate","tags":["Department & Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the department.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DepartmentUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.archive":{"post":{"summary":"location.archive","description":"Archives a location or location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationarchive) permission.**","operationId":"locationArchive","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationArchiveRequest"}}}},"responses":{"200":{"description":"Responses from the location.archive endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationArchiveSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.create":{"post":{"summary":"location.create","description":"Creates a location or location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationcreate) permission.**","operationId":"locationCreate","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCreateRequest"}}}},"responses":{"200":{"description":"Responses from the location.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.restore":{"post":{"summary":"location.restore","description":"Restores an archived location or location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationrestore) permission.**","operationId":"locationRestore","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationRestoreRequest"}}}},"responses":{"200":{"description":"Responses from the location.restore endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationRestoreSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.list":{"post":{"summary":"location.list","description":"List all locations. Regions are not returned.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`organizationRead`](authentication#permissions-locationlist) permission.**","operationId":"locationList","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationListRequest"}}}},"responses":{"200":{"description":"Responses from the location.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.info":{"post":{"summary":"location.info","description":"Gets details for a single location by id.\n\n**Requires the [`organizationRead`](authentication#permissions-locationinfo) permission.**","operationId":"locationInfo","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationInfoRequest"}}}},"responses":{"200":{"description":"Responses from the location.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.move":{"post":{"summary":"location.move","description":"Moves a location in location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationmove) permission.**","operationId":"locationMove","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationMoveRequest"}}}},"responses":{"200":{"description":"Responses from the location.move endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationMoveSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.updateAddress":{"post":{"summary":"location.updateAddress","description":"Update an address of a location or location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationupdateaddress) permission.**","operationId":"locationUpdateAddress","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdateAddressRequest"}}}},"responses":{"200":{"description":"Responses from the location.updateAddress endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationUpdateAddressSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.updateName":{"post":{"summary":"location.updateName","description":"Update location's name.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationupdatename) permission.**","operationId":"locationUpdateName","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdateNameRequest"}}}},"responses":{"200":{"description":"Responses from the location.updateName endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationUpdateNameSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.updateWorkplaceType":{"post":{"summary":"location.updateWorkplaceType","description":"Update location's workplace type.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationupdateworkplacetype) permission.**","operationId":"locationUpdateWorkplaceType","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdateWorkplaceTypeRequest"}}}},"responses":{"200":{"description":"Responses from the location.updateWorkplaceType endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationUpdateWorkplaceTypeSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/location.updateExternalName":{"post":{"summary":"location.updateExternalName","description":"Update a location's external (candidate-facing) name.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationupdateexternalname) permission.**","operationId":"locationUpdateExternalName","tags":["Location"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdateExternalNameRequest"}}}},"responses":{"200":{"description":"Responses from the location.updateExternalName endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/LocationUpdateExternalNameSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewPlan.list":{"post":{"summary":"interviewPlan.list","description":"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.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewplanlist) permission.**","operationId":"interviewPlanList","tags":["Interview Plan"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewPlanListRequest"}}}},"responses":{"200":{"description":"Responses from the interviewPlan.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewPlanListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","title":"Engineering Interview Plan","isArchived":false,"createdAt":"2022-08-12T20:29:56.964Z","updatedAt":"2023-09-13T21:30:57.965Z"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewStage.list":{"post":{"summary":"interviewStage.list","description":"List all interview stages for an interview plan in order.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewstagelist) permission.**","operationId":"interviewStageList","tags":["Interview Stage"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewStageListRequest"}}}},"responses":{"200":{"description":"Responses from the interviewStage.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewStageListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Technical Interview","type":"Active","interviewPlanId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","orderInInterviewPlan":0,"interviewStageGroupId":null}],"moreDataAvailable":false}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewStageGroup.list":{"post":{"summary":"interviewStageGroup.list","description":"List all interview stage groups in the organization in order.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewstagegrouplist) permission.**","operationId":"interviewStageGroupList","tags":["Interview Stage Group"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewStageGroupListRequest"}}}},"responses":{"200":{"description":"Responses from the interviewStageGroup.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewStageGroupListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","title":"Technical Screening","order":1,"stageType":"Active"}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/notetakerTranscript.info":{"post":{"summary":"notetakerTranscript.info","description":"Fetches metadata and a pre-signed download URL for an AI\nNotetaker transcript recording.\n\n**Prerequisites:**\n- Your organization must have the **AI Notetaker add-on**. If your organization does not have\n  the add-on, requests will fail with the `notetaker_transcript_not_enabled` error.\n\nThe response includes a signed URL with the transcript JSON. Download the file promptly after calling\n  this endpoint. If the URL has expired, call the endpoint again to get a fresh one.\n\nOn the free tier, transcripts expire after a retention period. Requesting an expired\ntranscript returns the `notetaker_transcript_expired` error. Organizations with unlimited\nAI Notetaker access are not subject to this expiry.\n\nUse the `notetakerTranscriptId` field from\n[`interviewEvent.list`](ref:intervieweventlist) or [`interviewSchedule.list`](ref:interviewschedulelist) to discover\ntranscript IDs for interview events.\n\n**Error codes:**\n\n| Code | Description |\n|---|---|\n| `notetaker_transcript_not_enabled` | Your organization does not have the AI Notetaker add-on. |\n| `notetaker_transcript_not_found` | No transcript exists with the given ID, or you do not have access to it. |\n| `notetaker_transcript_expired` | The transcript has expired. Upgrade to unlimited AI Notetaker to retain transcripts indefinitely. |\n| `invalid_input` | The provided `notetakerTranscriptId` is not a valid UUID. |\n\nConfigure API key permissions in **Admin → API Keys**. See [Managing API Key Permissions](authentication#managing-api-key-permissions).\n\n**Requires the [`notetakerRead`](authentication#permissions-notetakertranscriptinfo) permission.**","operationId":"notetakerTranscriptInfo","tags":["Notetaker Transcript"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotetakerTranscriptInfoRequest"}}}},"responses":{"200":{"description":"Responses from the notetakerTranscript.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NotetakerTranscriptInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","interviewEventId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","interviewScheduleId":"a0bbb968-e31d-4e23-800a-2f75ed4ec107","createdAt":"2026-04-25T02:46:41.817Z","participants":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","type":"interviewer","name":"Jane Smith","email":"jane.smith@example.com"},{"id":"7211e226-7802-41fd-8d55-2720fe9d534f","type":"candidate","name":"John Doe","email":"john.doe@example.com"}],"transcriptUrl":"https://s3.amazonaws.com/..."}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.approve":{"post":{"summary":"offer.approve","description":"Approves an offer or a specific approval step within an offer's approval process.\n\nThis 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.\n\nThis endpoint can be used in two ways:\n1. **Approve entire offer**: Call without `approvalStepId` and `userId` to approve the entire offer approval process\n2. **Approve specific step**: Provide both `approvalStepId` and `userId` to approve a specific step in the approval process\n\nWhen 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.\n\n**Requires the [`offersWrite`](authentication#permissions-offerapprove) permission.**","operationId":"offerApprove","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferApproveRequest"}}}},"responses":{"200":{"description":"Responses from the offer.approve endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferApproveSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":"Approved"},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.create":{"post":{"summary":"offer.create","description":"Creates a new Offer\n\nOffer forms support a variety of field types. The values accepted for each field depend on the type of field that's being filled out:\n- `Boolean` - A boolean value.\n- `Currency` - An object in the format `{ currencyCode: \"USD\", value: 100000 }` where currencyCode is a valid ISO 4217 currency code and value is an integer.\n- `Date` - A valid ISO Date string.\n- `Number` - An integer.\n- `String` - A string.\n- `ValueSelect` - A string that matches the value of one of the ValueSelect field's selectable options.\n- `MultiValueSelect` - An array of strings that exist in the MultiValueSelect field's selectable options.\n\n**Error codes:**\n\n| Code | Description |\n|---|---|\n| `opening_in_use` | The opening is already in use by another offer. |\n| `opening_state_invalid` | The opening has already been closed or filled by a different application.. |\n\n**Requires the [`offersWrite`](authentication#permissions-offercreate) permission.**","operationId":"offerCreate","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferCreateRequest"}}}},"responses":{"200":{"description":"Responses from the offer.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnApprovalStart","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.list":{"post":{"summary":"offer.list","description":"Get a list of all offers with their latest version.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`offersRead`](authentication#permissions-offerlist) permission.**","operationId":"offerList","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferListRequest"}}}},"responses":{"200":{"description":"Responses from the offer.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.info":{"post":{"summary":"offer.info","description":"Returns details about a single offer by id\n\n**Requires the [`offersRead`](authentication#permissions-offerinfo) permission.**","operationId":"offerInfo","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferInfoRequest"}}}},"responses":{"200":{"description":"Responses from the offer.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.start":{"post":{"summary":"offer.start","description":"The offer.start endpoint creates and returns an offer version instance that can be filled out and submitted\nusing the `offer.create` endpoint.\n\nIn order to create a new offer version for a candidate with an in-progress\noffer process, you can call the `offer.start` endpoint and then call the `offer.create` endpoint to fill out the\nnewly created offer version form.\n\n**Requires the [`offersWrite`](authentication#permissions-offerstart) permission.**","operationId":"offerStart","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferStartRequest"}}}},"responses":{"200":{"description":"Responses from the offer.start endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferStartSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.startApprovalProcess":{"post":{"summary":"offer.startApprovalProcess","description":"Starts the approval process for an offer in a \"WaitingOnApprovalStart\" state.\nOnce started, the approval is sent to the configured approvers.\n\nThe offer version ID can be obtained from the offer (e.g. `offer.info` or `offer.list` response's `latestVersion.id`).\n\n**Requires the [`offersWrite`](authentication#permissions-offerstartapprovalprocess) permission.**","operationId":"offerStartApprovalProcess","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferStartApprovalProcessRequest"}}}},"responses":{"200":{"description":"Responses from the offer.startApprovalProcess endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferStartApprovalProcessSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Created","offerStatus":"WaitingOnOfferApproval","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.update":{"post":{"summary":"offer.update","description":"Updates an existing Offer\n\nOffer forms support a variety of field types. The values accepted for each field depend on the type of field that's being filled out:\n- `Boolean` - A boolean value.\n- `Currency` - An object in the format `{ currencyCode: \"USD\", value: 100000 }` where currencyCode is a valid ISO 4217 currency code and value is an integer.\n- `Date` - A valid ISO Date string.\n- `Number` - An integer.\n- `String` - A string.\n- `ValueSelect` - A string that matches the value of one of the ValueSelect field's selectable options.\n- `MultiValueSelect` - An array of strings that exist in the MultiValueSelect field's selectable options.\n\nCalling this endpoint will create a new version of the offer and retrigger any necessary approval steps.\n\n**Requires the [`offersWrite`](authentication#permissions-offerupdate) permission.**","operationId":"offerUpdate","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the offer.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.setStatus":{"post":{"summary":"offer.setStatus","description":"Updates an offer's acceptance status.\n\nAshby derives the offer status from the provided acceptance status; `offerStatus` can't be set independently.\n\n**Requires the [`offersWrite`](authentication#permissions-offersetstatus) permission.**","operationId":"offerSetStatus","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferSetStatusRequest"}}}},"responses":{"200":{"description":"Responses from the offer.setStatus endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferSetStatusSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Accepted","offerStatus":"CandidateAccepted","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offer.setDecidedAt":{"post":{"summary":"offer.setDecidedAt","description":"Updates an offer's decidedAt timestamp.\n\n**Requires the [`offersWrite`](authentication#permissions-offersetdecidedat) permission.**","operationId":"offerSetDecidedAt","tags":["Offer"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferSetDecidedAtRequest"}}}},"responses":{"200":{"description":"Responses from the offer.setDecidedAt endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferSetDecidedAtSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":"2026-06-01T12:00:00.000Z","applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/offerProcess.start":{"post":{"summary":"offerProcess.start","description":"Starts an offer process for a candidate.\n\n**Requires the [`offersWrite`](authentication#permissions-offerprocessstart) permission.**","operationId":"offerProcessStart","tags":["Offer Process"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferProcessStartRequest"}}}},"responses":{"200":{"description":"Responses from the offerProcess.start endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OfferProcessStartSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","status":"WaitingOnOfferCreation"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.info":{"post":{"summary":"opening.info","description":"Retrieves an opening by its UUID.\n\n**Requires the [`jobsRead`](authentication#permissions-openinginfo) permission.**","operationId":"openingInfo","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningInfoRequest"}}}},"responses":{"200":{"description":"Responses from the opening.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.create":{"post":{"summary":"opening.create","description":"Creates an opening.\n\nTo set values of custom fields on Openings, use the [`customField.setValue`](ref:customfieldsetvalue) endpoint.\n\n**Requires the [`jobsWrite`](authentication#permissions-openingcreate) permission.**","operationId":"openingCreate","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningCreateRequest"}}}},"responses":{"200":{"description":"Responses from the opening.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.update":{"post":{"summary":"opening.update","description":"Updates an opening.\n\nTo set values for custom fields on Openings, use the [`customField.setValue`](ref:customfieldsetvalue) endpoint.\n\n**Requires the [`jobsWrite`](authentication#permissions-openingupdate) permission.**","operationId":"openingUpdate","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the opening.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.setArchived":{"post":{"summary":"opening.setArchived","description":"Sets the archived state of an opening.\n\n**Requires the [`jobsWrite`](authentication#permissions-openingsetarchived) permission.**","operationId":"openingSetArchived","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningSetArchivedRequest"}}}},"responses":{"200":{"description":"Responses from the opening.setArchived endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningSetArchivedSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.setOpeningState":{"post":{"summary":"opening.setOpeningState","description":"Sets the state of an opening.\n\n**Requires the [`jobsWrite`](authentication#permissions-openingsetopeningstate) permission.**","operationId":"openingSetOpeningState","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningSetOpeningStateRequest"}}}},"responses":{"200":{"description":"Responses from the opening.setOpeningState endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningSetOpeningStateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.addJob":{"post":{"summary":"opening.addJob","description":"Adds a job to an opening.\n\n**Requires the [`jobsWrite`](authentication#permissions-openingaddjob) permission.**","operationId":"openingAddJob","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningAddJobRequest"}}}},"responses":{"200":{"description":"Responses from the opening.addJob endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningAddJobSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.removeJob":{"post":{"summary":"opening.removeJob","description":"Removes a job from an opening.\n\n**Requires the [`jobsWrite`](authentication#permissions-openingremovejob) permission.**","operationId":"openingRemoveJob","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningRemoveJobRequest"}}}},"responses":{"200":{"description":"Responses from the opening.removeJob endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningRemoveJobSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.addLocation":{"post":{"summary":"opening.addLocation","description":"Adds a location to an opening.\n\n**Requires the [`jobsWrite`](authentication#permissions-openingaddlocation) permission.**","operationId":"openingAddLocation","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningAddLocationRequest"}}}},"responses":{"200":{"description":"Responses from the opening.addLocation endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningAddLocationSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.removeLocation":{"post":{"summary":"opening.removeLocation","description":"Removes a location from an opening.\n\n**Requires the [`jobsWrite`](authentication#permissions-openingremovelocation) permission.**","operationId":"openingRemoveLocation","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningRemoveLocationRequest"}}}},"responses":{"200":{"description":"Responses from the opening.removeLocation endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningRemoveLocationSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.list":{"post":{"summary":"opening.list","description":"Lists openings.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`jobsRead`](authentication#permissions-openinglist) permission.**","operationId":"openingList","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningListRequest"}}}},"responses":{"200":{"description":"Responses from the opening.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/opening.search":{"post":{"summary":"opening.search","description":"Searches for openings by identifier.\n\n**Requires the [`jobsRead`](authentication#permissions-openingsearch) permission.**","operationId":"openingSearch","tags":["Openings"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpeningSearchRequest"}}}},"responses":{"200":{"description":"Responses from the opening.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OpeningSearchSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/project.info":{"post":{"summary":"project.info","description":"Retrieves a project by its UUID.\n\n**Requires the [`candidatesRead`](authentication#permissions-projectinfo) permission.**","operationId":"projectInfo","tags":["Project"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectInfoRequest"}}}},"responses":{"200":{"description":"Responses from the project.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProjectInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","title":"My Project","isArchived":false,"authorId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","description":"A project for sourcing candidates","confidential":false,"customFieldEntries":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/project.list":{"post":{"summary":"project.list","description":"Lists projects.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-projectlist) permission.**","operationId":"projectList","tags":["Project"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectListRequest"}}}},"responses":{"200":{"description":"Responses from the project.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProjectListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","title":"My Project","isArchived":false,"authorId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","description":"A project for sourcing candidates","confidential":false,"customFieldEntries":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/project.search":{"post":{"summary":"project.search","description":"Search for projects by title.\n\nResponses 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.\n\n**Requires the [`candidatesRead`](authentication#permissions-projectsearch) permission.**","operationId":"projectSearch","tags":["Project"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectSearchRequest"}}}},"responses":{"200":{"description":"Responses from the project.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProjectSearchSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","title":"My Project","isArchived":false,"authorId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","description":"A project for sourcing candidates","confidential":false,"customFieldEntries":[]}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/source.list":{"post":{"summary":"source.list","description":"List all sources\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-sourcelist) permission.**","operationId":"sourceList","tags":["Source"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceListRequest"}}}},"responses":{"200":{"description":"Responses from the source.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SourceListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7","title":"Applied","isArchived":false,"sourceType":{"id":"9fbf7e23-bce5-4eb2-a4cb-3a05ec02db83","title":"Inbound","isArchived":false}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sourceTrackingLink.list":{"post":{"summary":"sourceTrackingLink.list","description":"List all source custom tracking links\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-sourcetrackinglinklist) permission.**","operationId":"sourceTrackingLinkList","tags":["Source Tracking Links"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceTrackingLinkListRequest"}}}},"responses":{"200":{"description":"Responses from the sourceTrackingLink.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SourceTrackingLinkListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","code":"fx9iL4QtWr","enabled":true,"sourceId":"5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7","link":"https://jobs.ashbyhq.com/example?utm_source=fx9iL4QtWr"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/archiveReason.list":{"post":{"summary":"archiveReason.list","description":"Lists archive reasons.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-archivereasonlist) permission.**","operationId":"archiveReasonList","tags":["Archive Reason"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveReasonListRequest"}}}},"responses":{"200":{"description":"Responses from the archiveReason.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ArchiveReasonListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","text":"Too inexperienced","reasonType":"RejectedByOrg","isArchived":false}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/brand.list":{"post":{"summary":"brand.list","description":"Lists all brands for the organization.\n\n**Requires the [`organizationRead`](authentication#permissions-brandlist) permission.**","operationId":"brandList","tags":["Brand"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandListRequest"}}}},"responses":{"200":{"description":"Responses from the brand.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BrandListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Acme","hostedJobsPageSlug":"acme"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/customField.list":{"post":{"summary":"customField.list","description":"Lists all custom fields.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-customfieldlist) permission.**","operationId":"customFieldList","tags":["Custom Field"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldListRequest"}}}},"responses":{"200":{"description":"Responses from the customField.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomFieldListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Preferred Team","description":"A description of the custom field","objectType":"Application","isArchived":false,"isPrivate":false,"fieldType":"String","isRequired":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/customField.create":{"post":{"summary":"customField.create","description":"Create a new custom field.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-customfieldcreate) permission.**","operationId":"customFieldCreate","tags":["Custom Field"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldCreateRequest"}}}},"responses":{"200":{"description":"Responses from the customField.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomFieldCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Preferred Team","description":"A description of the custom field","objectType":"Application","isArchived":false,"isPrivate":false,"fieldType":"String","isRequired":false}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/customField.setValue":{"post":{"summary":"customField.setValue","description":"Set the value of a custom field for a given object.\n\n**Note:** When updating multiple custom fields on the same object, use\n[`customField.setValues`](#operation/customFieldSetValues) instead to avoid\nrace conditions.\n\n**Note:** To set custom fields on an Employee, use [`user.setCustomFieldValue`](#operation/userSetCustomFieldValue) instead.\n\nThe values accepted in the `fieldValue` param depend on the type of field that's being updated. See below for more details:\n  - Boolean - A boolean value\n  - Date - An ISO Date string\n  - LongText, String - String\n  - ValueSelect - A string that matches the value of one of the ValueSelect field's options\n  - MultiValueSelect - An array of strings that exist in the MultiValueSelect field's options\n  - Number - A number\n  - Currency - An object with the following properties:\n    - value: A number\n    - currencyCode: A valid ISO 4217 currency code\n  - NumberRange - An object with the following properties:\n    - type: \"number-range\"\n    - minValue: A number\n    - maxValue: A number\n  - CompensationRange - An object with the following properties:\n    - type: \"compensation-range\"\n    - minValue: A number\n    - maxValue: A number\n    - currencyCode: A string\n    - interval: A valid interval string\n  - Url - A valid http or https URL (e.g., https://example.com)\n  - UUID - A valid UUID string (e.g., for Employee fields)\n\n**Requires the [`candidatesWrite`](authentication#permissions-customfieldsetvalue) permission.**","operationId":"customFieldSetValue","tags":["Custom Field"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldSetValueRequest"}}}},"responses":{"200":{"description":"Responses from the customField.setValue endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomFieldSetValueSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Preferred Team","isPrivate":false,"value":"Backend"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/customField.info":{"post":{"summary":"customField.info","description":"Get information about a custom field.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-customfieldinfo) permission.**","operationId":"customFieldInfo","tags":["Custom Field"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldInfoRequest"}}}},"responses":{"200":{"description":"Responses from the customField.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomFieldInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Preferred Team","description":"A description of the custom field","objectType":"Application","isArchived":false,"isPrivate":false,"fieldType":"String","isRequired":false}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/customField.setValues":{"post":{"summary":"customField.setValues","description":"Set the values of multiple custom fields for a given object in a single call.\nThis is the recommended approach when updating multiple fields on the same object\nto avoid race conditions that can occur with concurrent `customField.setValue` calls.\n\n**Note:** To set custom fields on an Employee, use [`user.setCustomFieldValues`](#operation/userSetCustomFieldValues) instead.\n\nThe 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.\n\n**Requires the [`candidatesWrite`](authentication#permissions-customfieldsetvalues) permission.**","operationId":"customFieldSetValues","tags":["Custom Field"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldSetValuesRequest"}}}},"responses":{"200":{"description":"Responses from the customField.setValues endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomFieldSetValuesSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Preferred Team","isPrivate":false,"value":"Backend"}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/customField.updateSelectableValues":{"post":{"summary":"customField.updateSelectableValues","description":"Update the selectable values for a custom field.\n\nThis endpoint merges the provided selectable values with the existing values for a custom field.\n\n**Merge behavior:**\n- **New values** (values not present in the existing values) are added to the field\n- **Existing values** (matching by `value` field) have their `label` updated and `isArchived` status set from the request\n- **Omitted values** (existing values not included in the request) are marked as archived\n- Metadata such as substitution tokens are preserved for existing values\n\nThe `isArchived` field defaults to `false` if not provided.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-customfieldupdateselectablevalues) permission.**","operationId":"customFieldUpdateSelectableValues","tags":["Custom Field"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldUpdateSelectableValuesRequest"}}}},"responses":{"200":{"description":"Responses from the customField.updateSelectableValues endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomFieldUpdateSelectableValuesSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Preferred Team","description":"A description of the custom field","objectType":"Application","isArchived":false,"isPrivate":false,"fieldType":"String","isRequired":false}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/assessment.update":{"post":{"summary":"assessment.update","description":"Update Ashby about the status of a started assessment.\n\n`assessment_status` is required unless `cancelled_reason` is provided.\n\n**Requires the [`candidatesWrite`](authentication#permissions-assessmentupdate) permission.**","operationId":"assessmentUpdate","tags":["Assessment"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the assessment.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AssessmentUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"assessmentId":"completed-node-assessment"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/assessment.addCompletedToCandidate":{"post":{"summary":"assessment.addCompletedToCandidate","description":"Add a completed assessment to a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-assessmentaddcompletedtocandidate) permission.**","operationId":"assessmentAddCompletedToCandidate","tags":["Assessment"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentAddCompletedToCandidateRequest"}}}},"responses":{"200":{"description":"Responses from the assessment.addCompletedToCandidate endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AssessmentAddCompletedToCandidateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","assessmentTypeId":"node-assessment","assessmentName":"Node Assessment","assessmentId":"completed-node-assessment","result":{"identifier":"result","label":"Score","type":"numeric_score","value":10},"metadata":[{"identifier":"result-max","label":"Max Score","type":"numeric_score","value":10}],"applicationId":null,"candidateId":"f1e2d3c4-b5a6-4789-9012-3456789abcde"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/hiringTeam.addMember":{"post":{"summary":"hiringTeam.addMember","description":"Adds an Ashby user to the hiring team at the application, job, or opening level.\n\n**Requires the [`organizationWrite`](authentication#permissions-hiringteamaddmember) permission.**","operationId":"hiringTeamAddMember","tags":["Hiring Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HiringTeamAddMemberRequest"}}}},"responses":{"200":{"description":"Responses from the hiringTeam.addMember endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HiringTeamAddMemberSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"userId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","firstName":"Joey","lastName":"Joe","email":"joey.joe@example.com","role":"Hiring Manager"}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/hiringTeam.removeMember":{"post":{"summary":"hiringTeam.removeMember","description":"Removes an Ashby user from the hiring team at the application, job, or opening level.\n\n**Requires the [`organizationWrite`](authentication#permissions-hiringteamremovemember) permission.**","operationId":"hiringTeamRemoveMember","tags":["Hiring Team"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HiringTeamRemoveMemberRequest"}}}},"responses":{"200":{"description":"Responses from the hiringTeam.removeMember endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HiringTeamRemoveMemberSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"userId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","firstName":"Joey","lastName":"Joe","email":"joey.joe@example.com","role":"Hiring Manager"}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/hiringTeamRole.list":{"post":{"summary":"hiringTeamRole.list","description":"Lists the possible hiring team roles in an organization\n\n**Requires the [`organizationRead`](authentication#permissions-hiringteamrolelist) permission.**","operationId":"hiringTeamRoleList","tags":["Hiring Team Role"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HiringTeamRoleListRequest"}}}},"responses":{"200":{"description":"Responses from the hiringTeamRole.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/HiringTeamRoleListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":["Recruiter"]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.info":{"post":{"summary":"user.info","description":"Retrieves detailed information about a specific user by their ID.\n\n**Requires the [`organizationRead`](authentication#permissions-userinfo) permission.**","operationId":"userInfo","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInfoRequest"}}}},"responses":{"200":{"description":"Responses from the user.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","firstName":"Jane","lastName":"Smith","email":"jane.smith@example.com","globalRole":"Elevated Access","isEnabled":true,"updatedAt":"2024-01-15T10:30:00.000Z","managerId":"7f8e9d6c-5b4a-4e2d-9c0b-9a8f7e6d5c4b"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.list":{"post":{"summary":"user.list","description":"Lists all users in the organization with pagination support.\n\nBy default, only active (enabled) users are returned. Use `includeDeactivated: true` to include deactivated users.\n\nSupports incremental sync via `syncToken` to efficiently retrieve only users updated since the last sync.\n\n**Requires the [`organizationRead`](authentication#permissions-userlist) permission.**","operationId":"userList","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListRequest"}}}},"responses":{"200":{"description":"Responses from the user.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","firstName":"Jane","lastName":"Smith","email":"jane.smith@example.com","globalRole":"Elevated Access","isEnabled":true,"updatedAt":"2024-01-15T10:30:00.000Z","managerId":"7f8e9d6c-5b4a-4e2d-9c0b-9a8f7e6d5c4b"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.search":{"post":{"summary":"user.search","description":"Searches for users by email address.\n\nReturns an array containing the user if found, or an empty array if no user with the given email exists.\n\n**Requires the [`organizationRead`](authentication#permissions-usersearch) permission.**","operationId":"userSearch","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSearchRequest"}}}},"responses":{"200":{"description":"Responses from the user.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserSearchSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","firstName":"Jane","lastName":"Smith","email":"jane.smith@example.com","globalRole":"Elevated Access","isEnabled":true,"updatedAt":"2024-01-15T10:30:00.000Z","managerId":"7f8e9d6c-5b4a-4e2d-9c0b-9a8f7e6d5c4b"}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.interviewerSettings":{"post":{"summary":"user.interviewerSettings","description":"Get interviewer settings for a user.\n\n**Requires the [`organizationRead`](authentication#permissions-userinterviewersettings) permission.**","operationId":"userInterviewerSettings","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInterviewerSettingsRequest"}}}},"responses":{"200":{"description":"Responses from the user.interviewerSettings endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserInterviewerSettingsSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","dailyLimit":2,"weeklyLimit":10}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.updateInterviewerSettings":{"post":{"summary":"user.updateInterviewerSettings","description":"Update interviewer settings for a user.\n\nEither 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.\n\n**Requires the [`organizationWrite`](authentication#permissions-userupdateinterviewersettings) permission.**","operationId":"userUpdateInterviewerSettings","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateInterviewerSettingsRequest"}}}},"responses":{"200":{"description":"Responses from the user.updateInterviewerSettings endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserUpdateInterviewerSettingsSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","dailyLimit":3,"weeklyLimit":15}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.createInterviewerPause":{"post":{"summary":"user.createInterviewerPause","description":"Creates an interviewer pause for a user. While paused, the user will not be scheduled for interviews.\n\nA 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.\n\n**Requires the [`organizationWrite`](authentication#permissions-usercreateinterviewerpause) permission.**","operationId":"userCreateInterviewerPause","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateInterviewerPauseRequest"}}}},"responses":{"200":{"description":"Responses from the user.createInterviewerPause endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserCreateInterviewerPauseSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","startsAt":"2024-01-15T00:00:00.000Z","endsAt":"2024-02-15T00:00:00.000Z","comment":"On vacation","createdAt":"2024-01-14T10:30:00.000Z"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.listInterviewerPauses":{"post":{"summary":"user.listInterviewerPauses","description":"Lists all active or scheduled interviewer pauses for a user.\n\n**Requires the [`organizationRead`](authentication#permissions-userlistinterviewerpauses) permission.**","operationId":"userListInterviewerPauses","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListInterviewerPausesRequest"}}}},"responses":{"200":{"description":"Responses from the user.listInterviewerPauses endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserListInterviewerPausesSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","startsAt":"2024-01-15T00:00:00.000Z","endsAt":"2024-02-15T00:00:00.000Z","comment":"On vacation","createdAt":"2024-01-14T10:30:00.000Z"}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.deleteInterviewerPause":{"post":{"summary":"user.deleteInterviewerPause","description":"Deletes an interviewer pause.\n\n**Requires the [`organizationWrite`](authentication#permissions-userdeleteinterviewerpause) permission.**","operationId":"userDeleteInterviewerPause","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDeleteInterviewerPauseRequest"}}}},"responses":{"200":{"description":"Responses from the user.deleteInterviewerPause endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserDeleteInterviewerPauseSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.setCustomFieldValue":{"post":{"summary":"user.setCustomFieldValue","description":"Set the value of a custom field on an employee.\n\nThe 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.\n\n**Note:** When updating multiple custom fields on the same employee, use [`user.setCustomFieldValues`](#operation/userSetCustomFieldValues) instead to avoid race conditions.\n\n**Requires the [`organizationWrite`](authentication#permissions-usersetcustomfieldvalue) permission.**","operationId":"userSetCustomFieldValue","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSetCustomFieldValueRequest"}}}},"responses":{"200":{"description":"Responses from the user.setCustomFieldValue endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserSetCustomFieldValueSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Department","value":"Engineering","isPrivate":false}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/user.setCustomFieldValues":{"post":{"summary":"user.setCustomFieldValues","description":"Set the values of multiple custom fields on an employee in a single call.\nThis is the recommended approach when updating multiple fields on the same employee\nto avoid race conditions that can occur with concurrent `user.setCustomFieldValue` calls.\n\nThe 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.\n\n**Requires the [`organizationWrite`](authentication#permissions-usersetcustomfieldvalues) permission.**","operationId":"userSetCustomFieldValues","tags":["User"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSetCustomFieldValuesRequest"}}}},"responses":{"200":{"description":"Responses from the user.setCustomFieldValues endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/UserSetCustomFieldValuesSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Department","value":"Engineering","isPrivate":false}]}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/referral.create":{"post":{"summary":"referral.create","description":"Creates a referral\n\n**Requires the [`candidatesWrite`](authentication#permissions-referralcreate) permission.**","operationId":"referralCreate","tags":["Referral"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralCreateRequest"}}}},"responses":{"200":{"description":"Responses from the referral.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReferralCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":{"id":"7211e226-7802-41fd-8d55-2720fe9d534f","firstName":"George","lastName":"Bluth","email":"george@bluth.example"},"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/referralForm.info":{"post":{"summary":"referralForm.info","description":"Fetches the default referral form or creates a default referral form if none exists.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-referralforminfo) permission.**","operationId":"referralFormInfo","tags":["Referral Form"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralFormInfoRequest"}}}},"responses":{"200":{"description":"Responses from the referralForm.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReferralFormInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"ec0a6c43-c1f3-4d4e-92f9-9d9c7e6c8e8d","organizationId":"5d3b8d24-2f4f-4f3a-8f3a-6c4b7d2e5b1a","title":"Default Referral Form","isArchived":false,"isDefaultForm":true,"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"5c5d9b9e-5b3a-4f5b-9b7c-7e9c8a2d3e4f","type":"String","path":"_systemfield_name","humanReadablePath":"Name","title":"Name","isNullable":false}},{"isRequired":true,"field":{"id":"a7b6c5d4-e3f2-4a1b-9c8d-7e6f5a4b3c2d","type":"Email","path":"_systemfield_email","humanReadablePath":"Email","title":"Email","isNullable":false}}]}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/emailSender.list":{"post":{"summary":"emailSender.list","description":"> Beta\n>\n> This endpoint is in beta and may not be available for all organizations.\n\nLists 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.\n\nWithout 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.\n\n**Requires the [`sourcingRead`](authentication#permissions-emailsenderlist) permission.**","operationId":"emailSenderList","tags":["Email Sender"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSenderListRequest"}}}},"responses":{"200":{"description":"Responses from the emailSender.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/EmailSenderListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"email":"recruiting@example.com","displayName":"Example Recruiting","type":"OrganizationAlias"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sequence.add":{"post":{"summary":"sequence.add","description":"> Beta\n>\n> This endpoint is in beta and may not be available for all organizations.\n\nEnrolls 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.\n\nThe 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.\n\nIf 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.\n\n**Requires the [`sourcingWrite`](authentication#permissions-sequenceadd) permission.**","operationId":"sequenceAdd","tags":["Sequence"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceAddRequest"}}}},"responses":{"200":{"description":"Responses from the sequence.add endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SequenceAddSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"sequence":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","candidateId":"26906e15-ff36-4ed3-b25b-de806d7852f7","applicationId":"71c2be26-cd82-4b9f-8e61-3ca2ed94c9a7","sequenceTemplateId":"97f36cec-3736-4f14-b1e2-ec60a132efab","status":"NotStarted","createdAt":"2026-07-22T12:34:56.000Z","stages":[{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","from":{"email":"gob@example.com","displayName":"Gob Bluth"},"subject":"A simple subject","bodyHtml":"<p>Hello</p>","sendAfter":{"kind":"NoDelay"}}]},"startResult":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sequence.cancel":{"post":{"summary":"sequence.cancel","description":"Cancels a running sourcing sequence (campaign) for a candidate.\n\n**Requires the [`sourcingWrite`](authentication#permissions-sequencecancel) permission.**","operationId":"sequenceCancel","tags":["Sequence"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceCancelRequest"}}}},"responses":{"200":{"description":"Responses from the sequence.cancel endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SequenceCancelSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"sequenceId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sequence.discard":{"post":{"summary":"sequence.discard","description":"> Beta\n>\n> This endpoint is in beta and may not be available for all organizations.\n\nPermanently 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.\n\nRepeating 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.\n\n**Requires the [`sourcingWrite`](authentication#permissions-sequencediscard) permission.**","operationId":"sequenceDiscard","tags":["Sequence"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceDiscardRequest"}}}},"responses":{"200":{"description":"Responses from the sequence.discard endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SequenceDiscardSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"sequenceId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sequence.info":{"post":{"summary":"sequence.info","description":"> Beta\n>\n> This endpoint is in beta and may not be available for all organizations.\n\nRetrieves a candidate's sourcing sequence enrollment when it is visible to the acting user.\n\nNot-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.\n\nReturns sequence_not_found for missing, inaccessible, or non-sourcing sequences.\n\n**Requires the [`sourcingRead`](authentication#permissions-sequenceinfo) permission.**","operationId":"sequenceInfo","tags":["Sequence"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceInfoRequest"}}}},"responses":{"200":{"description":"Responses from the sequence.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SequenceInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","candidateId":"26906e15-ff36-4ed3-b25b-de806d7852f7","applicationId":"71c2be26-cd82-4b9f-8e61-3ca2ed94c9a7","sequenceTemplateId":"97f36cec-3736-4f14-b1e2-ec60a132efab","status":"NotStarted","createdAt":"2026-07-20T12:34:56.000Z","stages":[{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","from":{"email":"gob@example.com","displayName":"Gob Bluth"},"subject":"A simple subject","bodyHtml":"<p>Hello</p>","sendAfter":{"kind":"NoDelay"}}]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sequence.updateStage":{"post":{"summary":"sequence.updateStage","description":"> Beta\n>\n> This endpoint is in beta and may not be available for all organizations.\n\nReplaces the supplied subject or HTML body of one email stage in a not-started sourcing sequence. At least one of subject or bodyHtml is required. The reusable sequence template is not changed.\n\nSubject is plain text. bodyHtml 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.\n\nDrafts 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.\n\n**Requires the [`sourcingWrite`](authentication#permissions-sequenceupdatestage) permission.**","operationId":"sequenceUpdateStage","tags":["Sequence"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceUpdateStageRequest"}}}},"responses":{"200":{"description":"Responses from the sequence.updateStage endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SequenceUpdateStageSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","from":{"email":"gob@example.com","displayName":"Gob Bluth"},"subject":"A personalized subject","bodyHtml":"<p>Would you like to talk?</p>","sendAfter":{"kind":"NoDelay"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sequence.start":{"post":{"summary":"sequence.start","description":"> Beta\n>\n> This endpoint is in beta and may not be available for all organizations.\n\nValidates 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.\n\nValidation 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.\n\nReturns sequence_not_found for missing, inaccessible, non-sourcing, or already-started sequences.\n\n**Requires the [`sourcingWrite`](authentication#permissions-sequencestart) permission.**","operationId":"sequenceStart","tags":["Sequence"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceStartRequest"}}}},"responses":{"200":{"description":"Responses from the sequence.start endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SequenceStartSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"sequence":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","candidateId":"26906e15-ff36-4ed3-b25b-de806d7852f7","applicationId":"71c2be26-cd82-4b9f-8e61-3ca2ed94c9a7","sequenceTemplateId":"97f36cec-3736-4f14-b1e2-ec60a132efab","status":"Running","createdAt":"2026-07-23T12:34:56.000Z","stages":[{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","from":{"email":"gob@example.com","displayName":"Gob Bluth"},"sendAfter":{"kind":"NoDelay"}}]},"startResult":{"status":"Started","lintResult":{"info":[],"warnings":[],"errors":[],"requiredActions":[]}}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sequenceTemplate.info":{"post":{"summary":"sequenceTemplate.info","description":"Retrieves metadata for a reusable sourcing sequence template visible to the caller. Archived templates may be returned. Message subjects and bodies are not exposed.\n\nReturns sequence_template_not_found when the template does not exist, is not a reusable sourcing template, or is not visible to the caller.\n\n**Requires the [`sourcingRead`](authentication#permissions-sequencetemplateinfo) permission.**","operationId":"sequenceTemplateInfo","tags":["Sequence Template"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceTemplateInfoRequest"}}}},"responses":{"200":{"description":"Responses from the sequenceTemplate.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SequenceTemplateInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"97f36cec-3736-4f14-b1e2-ec60a132efab","title":"Senior Engineer outreach","isArchived":false,"unsubscribeLinkActive":true,"updatedAt":"2026-07-13T12:34:56.000Z","stages":[{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","sendAfter":{"kind":"NoDelay"}},{"id":"f03c715f-aa66-49ac-b983-04f51337760d","type":"Email","sendAfter":{"kind":"TimeIntervalElapsed","amount":3,"unit":"day","time":"09:00","timezone":"America/Los_Angeles","allowedWeekdays":[1,2,3,4,5]}}]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/sequenceTemplate.list":{"post":{"summary":"sequenceTemplate.list","description":"Lists reusable sourcing sequence templates visible to the caller. Returns template and cadence metadata only; message subjects and bodies are not exposed.\n\nArchived templates are excluded unless the includeArchived option is true. Use that option when maintaining a complete synchronized catalog.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`sourcingRead`](authentication#permissions-sequencetemplatelist) permission.**","operationId":"sequenceTemplateList","tags":["Sequence Template"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceTemplateListRequest"}}}},"responses":{"200":{"description":"Responses from the sequenceTemplate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SequenceTemplateListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewSchedule.list":{"post":{"summary":"interviewSchedule.list","description":"Gets all interview schedules in the organization.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewschedulelist) permission.**","operationId":"interviewScheduleList","tags":["Interview Schedule"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewScheduleListRequest"}}}},"responses":{"200":{"description":"Responses from the interviewSchedule.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewScheduleListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","status":"Cancelled","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","scheduledBy":null,"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","interviewEvents":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewSchedule.create":{"post":{"summary":"interviewSchedule.create","description":"Create a scheduled interview in Ashby.\n\n**Requires the [`interviewsWrite`](authentication#permissions-interviewschedulecreate) permission.**","operationId":"interviewScheduleCreate","tags":["Interview Schedule"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewScheduleCreateRequest"}}}},"responses":{"200":{"description":"Responses from the interviewSchedule.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewScheduleCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","status":"Cancelled","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","scheduledBy":null,"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","interviewEvents":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewSchedule.update":{"post":{"summary":"interviewSchedule.update","description":"Update an interview schedule. This endpoint allows you to add, cancel, or update interview events associated with an interview schedule.\n\nIn 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.\n\n**Requires the [`interviewsWrite`](authentication#permissions-interviewscheduleupdate) permission.**","operationId":"interviewScheduleUpdate","tags":["Interview Schedule"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewScheduleUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the interviewSchedule.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewScheduleUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","status":"Cancelled","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","scheduledBy":null,"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","interviewEvents":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewSchedule.cancel":{"post":{"summary":"interviewSchedule.cancel","description":"Cancel an interview schedule by id.\n\n**Requires the [`interviewsWrite`](authentication#permissions-interviewschedulecancel) permission.**","operationId":"interviewScheduleCancel","tags":["Interview Schedule"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewScheduleCancelRequest"}}}},"responses":{"200":{"description":"Responses from the interviewSchedule.cancel endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewScheduleCancelSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","status":"Cancelled","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","scheduledBy":null,"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","interviewEvents":[]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/takeHomeAssignment.list":{"post":{"summary":"takeHomeAssignment.list","description":"> Beta\n>\n> This endpoint is in beta and may not be available for all organizations.\n\nLists 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.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`interviewsRead`](authentication#permissions-takehomeassignmentlist) permission.**","operationId":"takeHomeAssignmentList","tags":["Take Home Assignment"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TakeHomeAssignmentListRequest"}}}},"responses":{"200":{"description":"Responses from the takeHomeAssignment.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TakeHomeAssignmentListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/takeHomeAssignment.info":{"post":{"summary":"takeHomeAssignment.info","description":"> Beta\n>\n> This endpoint is in beta and may not be available for all organizations.\n\nRetrieves 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.\n\n**Requires the [`interviewsRead`](authentication#permissions-takehomeassignmentinfo) permission.**","operationId":"takeHomeAssignmentInfo","tags":["Take Home Assignment"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TakeHomeAssignmentInfoRequest"}}}},"responses":{"200":{"description":"Responses from the takeHomeAssignment.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TakeHomeAssignmentInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","candidateId":"bf94fe6c-2571-4745-a59e-50921782705e","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","interviewId":"ff6c7d9d-71e3-4c9c-88b1-28824980c276","status":"WaitingOnFeedback","createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","submission":{"id":"1595e4fc-8140-454e-a25d-853b0947ecf8","submittedAt":"2026-04-25T02:46:46.230Z","notesHtml":"<p>This is my submission.</p>","notesPlain":"This is my submission.","fileHandles":[{"id":"9a9fc77a-0d83-4487-ae65-bb2f90c074f8","name":"take-home-submission.pdf","handle":"encrypted-file-handle"}]},"feedbackFormDefinitionId":"46648e83-f28f-43c4-a2a0-58e0599cff41","reviewers":[{"userId":"a6ad83df-8f93-4dc2-8588-76f29cc0b5f0","interviewEventId":"4736b6d2-5c97-43a6-a7c6-0228bf079411","feedbackLink":"https://app.ashbyhq.com/interview-briefings/4736b6d2-5c97-43a6-a7c6-0228bf079411/feedback","hasSubmittedFeedback":false,"feedbackSubmittedAt":null}]}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewEvent.list":{"post":{"summary":"interviewEvent.list","description":"Lists interview events associated with an interview schedule.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`interviewsRead`](authentication#permissions-intervieweventlist) permission.**","operationId":"interviewEventList","tags":["Interview Event"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewEventListRequest"}}}},"responses":{"200":{"description":"Responses from the interviewEvent.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewEventListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","interviewId":"ff6c7d9d-71e3-4c9c-88b1-28824980c276","interviewScheduleId":"9d34f544-c150-4d70-91c4-e8b0b4a72846","interviewerUserIds":["caea4d97-331d-46b1-a8e3-6b821c2214ef"],"interviewers":[{"id":"caea4d97-331d-46b1-a8e3-6b821c2214ef","firstName":"Lindsay","lastName":"Bluth","email":"lindsay@bluth.com","globalRole":"Organization Admin","isEnabled":true,"updatedAt":"2026-04-25T02:46:46.230Z","trainingRole":null,"interviewerPool":null,"isFeedbackRequired":true}],"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","startTime":"2026-04-26T15:00:00.000Z","endTime":"2026-04-26T16:00:00.000Z","feedbackLink":"https://app.ashbyhq.com/interview-briefings/4736b6d2-5c97-43a6-a7c6-0228bf079411/feedback","location":"Google Meet","meetingLink":"https://meet.google.com/abc-defg-hij","interviewerCalendarEventId":null,"hasSubmittedFeedback":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewBriefing.info":{"post":{"summary":"interviewBriefing.info","description":"Fetch the briefing data for an interview event. Returns the application,\ninterview, per-interviewer status, and the feedback form definition id\nneeded to render an interviewer-facing briefing or to submit feedback via\n[`applicationFeedback.submit`](applicationfeedbacksubmit).\n\nBy default, each interviewer in the response is returned as a `userId`\nwith status flags. Pass `expand: [\"interviewers\"]` to include the full\nuser and pool details for each interviewer. Other expansions return the\napplication, candidate, job, interview, and feedback form definition\ninline.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewbriefinginfo) permission.**","operationId":"interviewBriefingInfo","tags":["Interview Briefing"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewBriefingInfoRequest"}}}},"responses":{"200":{"description":"Responses from the interviewBriefing.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewBriefingInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","applicationId":"9d34f544-c150-4d70-91c4-e8b0b4a72846","interviewId":"ff6c7d9d-71e3-4c9c-88b1-28824980c276","interviewStageId":"5a3f9c2b-71e3-4c9c-88b1-28824980c276","interviewers":[{"userId":"caea4d97-331d-46b1-a8e3-6b821c2214ef","isFeedbackRequired":true,"hasSubmittedFeedback":false,"trainingRole":null}],"hasSubmittedFeedback":false,"feedbackFormDefinitionId":"9b2cb8d9-1a6b-4d4f-9c5d-69ef7b9a9f12"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interview.info":{"post":{"summary":"interview.info","description":"Fetch interview details by id.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewinfo) permission.**","operationId":"interviewInfo","tags":["Interview"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewInfoRequest"}}}},"responses":{"200":{"description":"Responses from the interview.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Technical Interview","externalTitle":"Technical Interview","type":"Interview","isArchived":false,"isDebrief":false,"isFeedbackRequired":true,"isFeedbackRequested":true,"instructionsHtml":"<p>Use the scorecard to evaluate the candidate.</p>","instructionsPlain":"Use the scorecard to evaluate the candidate.","jobId":"2cb69137-763a-4d6f-8f17-bbc3564ecb2e","feedbackFormDefinitionId":"07189c2e-cacd-489d-8946-165acacc386f"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interview.list":{"post":{"summary":"interview.list","description":"List all interviews.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewlist) permission.**","operationId":"interviewList","tags":["Interview"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewListRequest"}}}},"responses":{"200":{"description":"Responses from the interview.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Technical Interview","externalTitle":"Technical Interview","type":"Interview","isArchived":false,"isDebrief":false,"isFeedbackRequired":true,"isFeedbackRequested":true,"instructionsHtml":"<p>Use the scorecard to evaluate the candidate.</p>","instructionsPlain":"Use the scorecard to evaluate the candidate.","jobId":"2cb69137-763a-4d6f-8f17-bbc3564ecb2e","feedbackFormDefinitionId":"07189c2e-cacd-489d-8946-165acacc386f"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewStage.info":{"post":{"summary":"interviewStage.info","description":"Retrieves detailed information about a specific interview stage by its ID.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewstageinfo) permission.**","operationId":"interviewStageInfo","tags":["Interview Stage"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewStageInfoRequest"}}}},"responses":{"200":{"description":"Responses from the interviewStage.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewStageInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Technical Interview","type":"Active","interviewPlanId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","orderInInterviewPlan":0,"interviewStageGroupId":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/file.createFileUploadHandle":{"post":{"summary":"file.createFileUploadHandle","description":"Creates a presigned upload URL that allows uploading a file directly to storage, bypassing the need to send file bytes through the API.\n\nThe presigned URL expires after 10 minutes. The fileUploadContext must be one of CandidateResume, CandidateFiles, or ApplicationForm.\n\n**Requires the [`candidatesWrite`](authentication#permissions-filecreatefileuploadhandle) permission.**","operationId":"fileCreateFileUploadHandle","tags":["File"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileCreateFileUploadHandleRequest"}}}},"responses":{"200":{"description":"Responses from the file.createFileUploadHandle endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/FileCreateFileUploadHandleSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"handle":"encrypted-file-upload-handle","url":"https://uploads.example.com/","fields":{"key":"organization/file/resume.pdf","acl":"private"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/file.info":{"post":{"summary":"file.info","description":"Retrieve the URL for a file referenced by a public API file handle (candidate files, resumes, offer letters, and signature-request files).\n\n**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.\n\n**Requires the [`candidatesRead`](authentication#permissions-fileinfo) permission.**","operationId":"fileInfo","tags":["File"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfoRequest"}}}},"responses":{"200":{"description":"Responses from the file.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/FileInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"url":"https://s3.amazonaws.com/..."}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/surveyFormDefinition.info":{"post":{"summary":"surveyFormDefinition.info","description":"Returns details about a single survey form definition by id.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-surveyformdefinitioninfo) permission.**","operationId":"surveyFormDefinitionInfo","tags":["Survey Form Definition"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyFormDefinitionInfoRequest"}}}},"responses":{"200":{"description":"Responses from the surveyFormDefinition.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SurveyFormDefinitionInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"49e621fa-b342-413a-b876-5d924689c23b","title":"Example Candidate Experience Survey","isArchived":false,"formDefinition":{"sections":[{"fields":[{"isRequired":false,"field":{"id":"cb539763-33a2-4172-a915-dc14d9120671","type":"NPSRating","path":"_systemfield_overall_candexp_rating","humanReadablePath":"","title":"How likely are you to recommend us to others?","isNullable":false}}]}]},"surveyType":"CandidateExperience"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/surveyFormDefinition.list":{"post":{"summary":"surveyFormDefinition.list","description":"Lists all survey form definitions.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-surveyformdefinitionlist) permission.**","operationId":"surveyFormDefinitionList","tags":["Survey Form Definition"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyFormDefinitionListRequest"}}}},"responses":{"200":{"description":"Responses from the surveyFormDefinition.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SurveyFormDefinitionListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"49e621fa-b342-413a-b876-5d924689c23b","title":"Example Candidate Experience Survey","isArchived":false,"formDefinition":{"sections":[{"fields":[{"isRequired":false,"field":{"id":"cb539763-33a2-4172-a915-dc14d9120671","type":"NPSRating","path":"_systemfield_overall_candexp_rating","humanReadablePath":"","title":"How likely are you to recommend us to others?","isNullable":false}}]}]},"surveyType":"CandidateExperience"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/surveyRequest.create":{"post":{"summary":"surveyRequest.create","description":"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.\n\n**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.\n\n**Requires the [`candidatesWrite`](authentication#permissions-surveyrequestcreate) permission.**","operationId":"surveyRequestCreate","tags":["Survey Request"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyRequestCreateRequest"}}}},"responses":{"200":{"description":"Responses from the surveyRequest.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SurveyRequestCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyUrl":"https://example.ashbyhq.com/acme/survey/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyFormDefinitionId":"49e621fa-b342-413a-b876-5d924689c23b","applicationId":"38fdb18a-5753-48e0-8a55-d8a124c346b2","candidateId":"d13f3430-d0de-4305-b41c-444d02f19954"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/surveyRequest.list":{"post":{"summary":"surveyRequest.list","description":"Lists all survey requests.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-surveyrequestlist) permission.**","operationId":"surveyRequestList","tags":["Survey Request"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyRequestListRequest"}}}},"responses":{"200":{"description":"Responses from the surveyRequest.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SurveyRequestListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyUrl":"https://example.ashbyhq.com/acme/survey/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyFormDefinitionId":"49e621fa-b342-413a-b876-5d924689c23b","applicationId":"38fdb18a-5753-48e0-8a55-d8a124c346b2","candidateId":"d13f3430-d0de-4305-b41c-444d02f19954"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/surveySubmission.create":{"post":{"summary":"surveySubmission.create","description":"Creates a survey submission for a candidate and application.\n\n**Requires the [`candidatesWrite`](authentication#permissions-surveysubmissioncreate) permission.**","operationId":"surveySubmissionCreate","tags":["Survey Submission"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveySubmissionCreateRequest"}}}},"responses":{"200":{"description":"Responses from the surveySubmission.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SurveySubmissionCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyFormDefinitionId":"49e621fa-b342-413a-b876-5d924689c23b","submittedAt":"2026-05-21T02:02:17.342Z","candidateId":"d13f3430-d0de-4305-b41c-444d02f19954","applicationId":"38fdb18a-5753-48e0-8a55-d8a124c346b2","surveyType":"CandidateExperience","formDefinition":{"sections":[{"fields":[{"isRequired":false,"field":{"id":"cb539763-33a2-4172-a915-dc14d9120671","type":"NPSRating","path":"_systemfield_overall_candexp_rating","humanReadablePath":"","title":"How likely are you to recommend us to others?","isNullable":false}}]}]},"submittedValues":{"_systemfield_overall_candexp_rating":"5"}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/surveySubmission.list":{"post":{"summary":"surveySubmission.list","description":"Lists all survey submissions of a given `surveyType`.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-surveysubmissionlist) permission.**","operationId":"surveySubmissionList","tags":["Survey Submission"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveySubmissionListRequest"}}}},"responses":{"200":{"description":"Responses from the surveySubmission.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SurveySubmissionListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyFormDefinitionId":"49e621fa-b342-413a-b876-5d924689c23b","submittedAt":"2026-05-21T02:02:17.342Z","candidateId":"d13f3430-d0de-4305-b41c-444d02f19954","applicationId":"38fdb18a-5753-48e0-8a55-d8a124c346b2","surveyType":"CandidateExperience","formDefinition":{"sections":[{"fields":[{"isRequired":false,"field":{"id":"cb539763-33a2-4172-a915-dc14d9120671","type":"NPSRating","path":"_systemfield_overall_candexp_rating","humanReadablePath":"","title":"How likely are you to recommend us to others?","isNullable":false}}]}]},"submittedValues":{"_systemfield_overall_candexp_rating":"5"}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/webhook.create":{"post":{"summary":"webhook.create","description":"Creates a webhook setting.\n\n**Requires the [`apiKeysWrite`](authentication#permissions-webhookcreate) permission.**","operationId":"webhookCreate","tags":["Webhook"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"}}}},"responses":{"200":{"description":"Responses from the webhook.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","enabled":true,"requestUrl":"https://example.com/webhook1","webhookType":"applicationSubmit","secretToken":"your-secret-token-here"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/webhook.info":{"post":{"summary":"webhook.info","description":"Retrieves information about a specific webhook setting by its ID.\n\n**Requires the [`apiKeysRead`](authentication#permissions-webhookinfo) permission.**","operationId":"webhookInfo","tags":["Webhook"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookInfoRequest"}}}},"responses":{"200":{"description":"Responses from the webhook.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","enabled":true,"requestUrl":"https://example.com/webhook1","webhookType":"applicationSubmit"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/webhook.update":{"post":{"summary":"webhook.update","description":"Updates a webhook setting. One of `enabled`, `requestUrl`, or `secretToken` must be provided.\n\n**Requires the [`apiKeysWrite`](authentication#permissions-webhookupdate) permission.**","operationId":"webhookUpdate","tags":["Webhook"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the webhook.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","enabled":true,"requestUrl":"https://example.com/webhook1","webhookType":"applicationSubmit","secretToken":"your-secret-token-here"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/webhook.delete":{"post":{"summary":"webhook.delete","description":"Deletes a webhook setting.\n\n**Requires the [`apiKeysWrite`](authentication#permissions-webhookdelete) permission.**","operationId":"webhookDelete","tags":["Webhook"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDeleteRequest"}}}},"responses":{"200":{"description":"Responses from the webhook.delete endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookDeleteSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"webhookId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewerPool.list":{"post":{"summary":"interviewerPool.list","description":"List all interviewer pools.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-interviewerpoollist) permission.**","operationId":"interviewerPoolList","tags":["Interviewer Pool"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewerPoolListRequest"}}}},"responses":{"200":{"description":"Responses from the interviewerPool.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewerPoolListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewerPool.info":{"post":{"summary":"interviewerPool.info","description":"Get information about an interviewer pool.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-interviewerpoolinfo) permission.**","operationId":"interviewerPoolInfo","tags":["Interviewer Pool"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewerPoolInfoRequest"}}}},"responses":{"200":{"description":"Responses from the interviewerPool.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewerPoolInfoSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewerPool.archive":{"post":{"summary":"interviewerPool.archive","description":"Archives an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolarchive) permission.**","operationId":"interviewerPoolArchive","tags":["Interviewer Pool"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewerPoolArchiveRequest"}}}},"responses":{"200":{"description":"Responses from the interviewerPool.archive endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewerPoolArchiveSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewerPool.restore":{"post":{"summary":"interviewerPool.restore","description":"Restores an archived interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolrestore) permission.**","operationId":"interviewerPoolRestore","tags":["Interviewer Pool"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewerPoolRestoreRequest"}}}},"responses":{"200":{"description":"Responses from the interviewerPool.restore endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewerPoolRestoreSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewerPool.create":{"post":{"summary":"interviewerPool.create","description":"Create an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolcreate) permission.**","operationId":"interviewerPoolCreate","tags":["Interviewer Pool"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewerPoolCreateRequest"}}}},"responses":{"200":{"description":"Responses from the interviewerPool.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewerPoolCreateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewerPool.update":{"post":{"summary":"interviewerPool.update","description":"Update an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolupdate) permission.**","operationId":"interviewerPoolUpdate","tags":["Interviewer Pool"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewerPoolUpdateRequest"}}}},"responses":{"200":{"description":"Responses from the interviewerPool.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewerPoolUpdateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewerPool.addUser":{"post":{"summary":"interviewerPool.addUser","description":"Add a user to an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpooladduser) permission.**","operationId":"interviewerPoolAddUser","tags":["Interviewer Pool"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewerPoolAddUserRequest"}}}},"responses":{"200":{"description":"Responses from the interviewerPool.addUser endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewerPoolAddUserSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/interviewerPool.removeUser":{"post":{"summary":"interviewerPool.removeUser","description":"Remove a user from an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolremoveuser) permission.**","operationId":"interviewerPoolRemoveUser","tags":["Interviewer Pool"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterviewerPoolRemoveUserRequest"}}}},"responses":{"200":{"description":"Responses from the interviewerPool.removeUser endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/InterviewerPoolRemoveUserSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/closeReason.list":{"post":{"summary":"closeReason.list","description":"Lists all close reasons for jobs or openings.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-closereasonlist) permission.**","operationId":"closeReasonList","tags":["Close Reason"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseReasonListRequest"}}}},"responses":{"200":{"description":"Responses from the closeReason.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CloseReasonListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"8d1f3b6c-6f31-4d29-9c1f-1f4c5b4d8f4a","reasonText":"Position Filled","isArchived":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/report.generate":{"post":{"summary":"report.generate","description":"> Beta\n>\n> This endpoint is currently in beta and may change without notice.\n\nGenerates a new report or polls the status of an existing report generation.\n\n**Two-step process:**\n1. Call with only `reportId` to start generation and receive a `requestId`.\n2. Poll with both `reportId` and `requestId` every second until `status` is `complete` or `failed`.\n\n**Result Style (`resultStyle`):**\n- `inline` (default): completed report data is embedded in the response under `reportData`.\n- `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`.\n- 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`.\n- 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.\n- 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.\n\n**Rate Limiting (Per Organization):**\n- **Start generation requests** (without `requestId`): 15 requests per minute per organization.\n- **Concurrent limit**: Maximum 3 report operations at once per organization (shared with `report.synchronous`).\n- **Polling requests** (with `requestId`): Bypass all limits.\n\n**Usage Notes:**\n- If you receive a 429 error, your organization has hit its limit. Wait and retry or use `report.synchronous`.\n- For synchronous retrieval of existing data, use `report.synchronous`.\n- Use this async endpoint for reports that may exceed 30 seconds.\n\n**Requires the [`reportsRead`](authentication#permissions-reportgenerate) permission.**","operationId":"reportGenerate","tags":["Report"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportGenerateRequest"}}}},"responses":{"200":{"description":"Responses from the report.generate endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReportGenerateSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"requestId":"rep_result:12345abc","status":"complete","reportData":{"data":[["Timeframe","Department","Hired"],["Q1 2024","Engineering",45],["Q1 2024","Sales",32],["Q2 2024","Engineering",52]],"columnNames":["Timeframe","Department","Hired"],"metadata":{"updatedAt":"2024-01-15T10:30:00.000Z","title":"Quarterly Hiring Report","reportGeneratedAt":"2024-01-15T14:25:33.123Z","cacheExpiresAt":"2024-01-15T15:25:33.123Z"}},"failureReason":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/report.synchronous":{"post":{"summary":"report.synchronous","description":"> Beta\n>\n> This endpoint is currently in beta and may change without notice.\n\nRetrieves report data synchronously.\n\n**Timeout:** 30 seconds. If a report is timing out, use the asynchronous `report.generate` instead.\n\n**Result Style (`resultStyle`):**\n- `inline` (default): completed report data is embedded in the response under `reportData`.\n- `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`.\n- 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.\n- 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.\n\n**Rate Limiting (Per Organization):**\n- **Request limit**: 15 requests per minute per organization.\n- **Concurrent limit**: Maximum 3 report operations at once per organization (shared with `report.generate`).\n- Rate limits are shared with `report.generate` for starting new generations.\n\n**Usage Notes:**\n- If you receive a 429 error, your organization has hit its limit - wait briefly and retry.\n- For long-running reports, use `report.generate` for async processing.\n- Concurrent limit is released when the HTTP request completes.\n\n**Requires the [`reportsRead`](authentication#permissions-reportsynchronous) permission.**","operationId":"reportSynchronous","tags":["Report"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSynchronousRequest"}}}},"responses":{"200":{"description":"Responses from the report.synchronous endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReportSynchronousSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":{"requestId":"rep_result:12345abc","status":"complete","reportData":{"data":[["Timeframe","Department","Hired"],["Q1 2024","Engineering",45],["Q1 2024","Sales",32],["Q2 2024","Engineering",52]],"columnNames":["Timeframe","Department","Hired"],"metadata":{"updatedAt":"2024-01-15T10:30:00.000Z","title":"Quarterly Hiring Report","reportGeneratedAt":"2024-01-15T14:25:33.123Z","cacheExpiresAt":"2024-01-15T15:25:33.123Z"}},"failureReason":null}}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/approval.list":{"post":{"summary":"approval.list","description":"Gets all approvals in the organization. You can optionally filter by entity type and entity ID.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`approvalsRead`](authentication#permissions-approvallist) permission.**","operationId":"approvalList","tags":["Approval"],"x-added-in-version":"2026-01-01","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovalListRequest"}}}},"responses":{"200":{"description":"Responses from the approval.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApprovalListSuccessResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]},"examples":{"success":{"summary":"Success response","value":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","approvalDefinitionId":"8af2ed38-6fd1-476b-9e95-3b57f6a0ee8f","entityId":"32665f7b-8d4c-4c58-9f28-62c5a4d20d57","entityType":"Offer","createdAt":"2024-01-15T10:30:00.000Z","submittedAt":"2024-01-15T10:35:00.000Z","completedAt":null,"steps":[{"id":"181c9a75-1646-4232-b312-e9a95b82af41","approvalsRequired":1,"completedAt":null,"approvers":[{"id":"f3268949-c6f2-4fb8-b85b-69806729fbb8","userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","decision":"pending","decidedAt":null,"requestedAt":"2024-01-15T10:35:00.000Z"}]}]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"error":{"summary":"Error response","value":{"success":false,"errors":[{"message":"Example error message"}]}}}}}}}}},"/assessment.list":{"post":{"summary":"assessment.list (Implemented by Partner)","operationId":"assessmentList","description":"The API for listing assessments that the partner supports — implemented by the partner, but called by Ashby\n","tags":["Assessment"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Responses for the assessment.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/AssessmentListItem"}]}}}}]},{"$ref":"#/components/schemas/OverlayErrorResponse"}]}}}}}}},"/assessment.start":{"post":{"summary":"assessment.start (Implemented by Partner)","operationId":"assessmentStart","description":"The API for starting an assessment. Implemented by the partner, called by Ashby.\n","tags":["Assessment"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["assessment_type_id","candidate","application","job"],"properties":{"assessment_type_id":{"allOf":[{"description":"The id of the type of assessment to start (retrieved from calling /assessment.list)"},{"$ref":"#/components/schemas/id"}]},"candidate":{"allOf":[{"description":"Identifier of the assessment being started"},{"$ref":"#/components/schemas/assessmentCandidate"}]},"application":{"allOf":[{"description":"The application for which the candidate is being assessed"},{"$ref":"#/components/schemas/assessmentApplication"}]},"job":{"allOf":[{"description":"The job for which the candidate is being assessed"},{"$ref":"#/components/schemas/assessmentJob"}]}}}}}},"responses":{"200":{"description":"Responses for the assessment.start endpoint","content":{"application/json":{"schema":{"title":"Success Response","type":"object","$ref":"#/components/schemas/AssessmentStartResponse"}}}},"409":{"description":"The assessment could not be started because the candidate is already being assessed.\n"},"422":{"description":"A custom error message that will be shown to the user in Ashby.\n","content":{"application/json":{"schema":{"title":"Custom Error Response","type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The message to be shown to the user in Ashby."}}}}}}}}},"/assessment.cancel":{"post":{"summary":"assessment.cancel (Implemented by Partner)","operationId":"assessmentCancel","description":"(Optional) Cancels an assessment. Implemented by the partner, called by Ashby.\n","tags":["Assessment"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["assessment_id"],"properties":{"assessment_id":{"allOf":[{"description":"The id of the started assessment to cancel"},{"$ref":"#/components/schemas/id"}]}}}}}},"responses":{"200":{"description":"Responses for the assessment.cancel endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","type":"object","$ref":"#/components/schemas/AssessmentStartResponse"},{"title":"Error Response","type":"object","$ref":"#/components/schemas/OverlayErrorResponse"}]}}}}}}},"/customFields.fetch":{"post":{"summary":"customFields.fetch (Implemented by Partner)","operationId":"assessmentPartnerCustomFieldsFetch","description":"The API for listing custom fields that can be synced to Ashby — implemented by the assessment partner, but called by Ashby.\n\nThis endpoint is optional. Ashby only calls it for integrations that have custom field sync enabled by Ashby. Contact Ashby if you wish to use this feature.\n\nOnce enabled, Ashby fetches your custom field definitions in three situations, not in real time as assessments are created:\n- On demand, when an Ashby admin clicks \"Sync Custom Fields\" on the integration settings page.\n- When an admin opens the custom fields settings page and Ashby has no field definitions stored for the integration.\n- On a schedule, automatically about once an hour.\n\nBecause syncing is periodic rather than per-assessment, new or changed fields on your side may take up to an hour to appear in Ashby unless an admin syncs manually.\n","tags":["Assessment"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Responses for the customFields.fetch endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","type":"object","additionalProperties":false,"properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentPartnerCustomField"}}},"required":["fields"]},{"$ref":"#/components/schemas/OverlayErrorResponse"}]}}}}}}}},"webhooks":{"applicationSubmit":{"post":{"summary":"applicationSubmit","description":"Triggered when a candidate submits an application or when a candidate is manually added to Ashby. This webhook is not triggered for bulk imports or integration syncs.","operationId":"applicationSubmitWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["applicationSubmit"]},"data":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/OverlayApplication"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"applicationUpdate":{"post":{"summary":"applicationUpdate","description":"Triggered when there's an update to an application. This includes:\n- Changes to application fields (source, custom fields, etc.)\n- Job transfers (when an application is moved to a different job)\n- Also triggered by [candidateHire](ref:candidatehirewebhook) and [candidateStageChange](ref:candidatestagechangewebhook)\n","operationId":"applicationUpdateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["applicationUpdate"]},"data":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/OverlayApplication"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"candidateHire":{"post":{"summary":"candidateHire","description":"Triggered when a candidate is hired (including candidates that are hired on confidential jobs).\nIncludes the application and most recent accepted offer (if one exists).\nAlso triggers [applicationUpdate](ref:applicationupdatewebhook) and [candidateStageChange](ref:candidatestagechangewebhook)\n","operationId":"candidateHireWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["candidateHire"]},"data":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/OverlayApplication"},"offer":{"$ref":"#/components/schemas/OverlayOffer"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"candidateStageChange":{"post":{"summary":"candidateStageChange","description":"Triggered when a candidate changes stages in an application. Also triggered by [candidateHire](ref:candidatehirewebhook)","operationId":"candidateStageChangeWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["candidateStageChange"]},"data":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/OverlayApplication"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"candidateDelete":{"post":{"summary":"candidateDelete","description":"Triggered when a candidate is deleted. \nIncludes the deleted candidate id.\n","operationId":"candidateDeleteWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["candidateDelete"]},"data":{"type":"object","properties":{"candidate":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id","description":"The unique id of the deleted candidate"}}}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"candidateMerge":{"post":{"summary":"candidateMerge","description":"Triggered when a candidate is merged. \nIncludes the deleted candidate's id and merged candidate data.\n","operationId":"candidateMergeWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["candidateMerge"]},"data":{"type":"object","properties":{"deletedCandidate":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id","description":"The unique id of the deleted candidate"}}},"mergedCandidate":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id","description":"The unique id of the final merged candidate"}}}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"interviewPlanTransition":{"post":{"summary":"interviewPlanTransition","description":"Triggered when a job's interview plan is switched to a different plan. Sends interview plan data and ids for the interview stage mappings. Also triggers [jobUpdate](ref:jobupdatewebhook)","operationId":"interviewPlanTransitionWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["interviewPlanTransition"]},"data":{"type":"object","properties":{"jobId":{"description":"The id of the job for which the interview plan has been switched","allOf":[{"$ref":"#/components/schemas/id"}]},"fromInterviewPlan":{"description":"The interview plan the job was previously referencing","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"title":{"type":"string","example":"Custom Interview Plan"}},"required":["id","title"]},"toInterviewPlan":{"description":"The interview plan the job is now referencing","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"title":{"type":"string","example":"Engineering Interview Plan"}},"required":["id","title"]},"interviewStageMappings":{"description":"The mapping of a stage from the previous interview plan to a stage on the new interview plan","type":"array","items":{"type":"object","properties":{"fromInterviewStageId":{"$ref":"#/components/schemas/id"},"toInterviewStageId":{"$ref":"#/components/schemas/id"}},"required":["fromInterviewStageId","toInterviewStageId"]}}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"interviewScheduleCreate":{"post":{"summary":"interviewScheduleCreate","description":"The webhook is called when an interview schedule is created. Also triggers [interviewScheduleUpdate](ref:interviewscheduleupdatewebhook)","operationId":"interviewScheduleCreateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["interviewScheduleCreate"]},"data":{"type":"object","properties":{"interviewSchedule":{"$ref":"#/components/schemas/OverlayInterviewSchedule"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"interviewScheduleUpdate":{"post":{"summary":"interviewScheduleUpdate","description":"The webhook is called when an interview schedule is updated, including when interviews that are part of the schedule are scheduled, updated, or cancelled. Also triggered by [interviewScheduleCreate](ref:interviewschedulecreatewebhook)","operationId":"interviewScheduleUpdateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["interviewScheduleUpdate"]},"data":{"type":"object","properties":{"interviewSchedule":{"allOf":[{"$ref":"#/components/schemas/OverlayInterviewSchedule"},{"type":"object","properties":{"candidateId":{"type":"string","description":"The ID of the candidate associated with this interview schedule"}}}]}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"jobCreate":{"post":{"summary":"jobCreate","description":"Triggered when a job is created","operationId":"jobCreateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["jobCreate"]},"data":{"type":"object","properties":{"job":{"$ref":"#/components/schemas/OverlayJob"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"jobUpdate":{"post":{"summary":"jobUpdate","description":"Triggered when a job is updated. Also triggered by [interviewPlanTransition](ref:interviewplantransitionwebhook)","operationId":"jobUpdateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["jobUpdate"]},"data":{"type":"object","properties":{"job":{"$ref":"#/components/schemas/OverlayJob"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"jobPostingDelete":{"post":{"summary":"jobPostingDelete","description":"Triggered when a job posting is deleted.\nIncludes the deleted job posting id and its associated job id.\n","operationId":"jobPostingDeleteWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["jobPostingDelete"]},"data":{"type":"object","properties":{"jobPosting":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id","description":"The unique id of the deleted job posting"},"jobId":{"$ref":"#/components/schemas/id","description":"The unique id of the job associated with the deleted job posting"}}}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"jobPostingUpdate":{"post":{"summary":"jobPostingUpdate","description":"Triggered when a job posting is updated. Also triggered by [jobPostingPublish](ref:jobpostingpublishwebhook) and [jobPostingUnpublish](ref:jobpostingunpublishwebhook)","operationId":"jobPostingUpdateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["jobPostingUpdate"]},"data":{"type":"object","properties":{"jobPosting":{"$ref":"#/components/schemas/OverlayJobPostingBrief"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"jobPostingPublish":{"post":{"summary":"jobPostingPublish","description":"Triggered when a job posting is published. Also triggers [jobPostingUpdate](ref:jobpostingupdatewebhook)","operationId":"jobPostingPublishWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["jobPostingPublish"]},"data":{"type":"object","properties":{"jobPosting":{"$ref":"#/components/schemas/OverlayJobPostingBrief"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"jobPostingUnpublish":{"post":{"summary":"jobPostingUnpublish","description":"Triggered when a job posting is unpublished. Also triggers [jobPostingUpdate](ref:jobpostingupdatewebhook)","operationId":"jobPostingUnpublishWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["jobPostingUnpublish"]},"data":{"type":"object","properties":{"jobPosting":{"$ref":"#/components/schemas/OverlayJobPostingBrief"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"offerCreate":{"post":{"summary":"offerCreate","description":"Triggered when a new offer process is created for a candidate","operationId":"offerCreateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["offerCreate"]},"data":{"type":"object","properties":{"offer":{"$ref":"#/components/schemas/OverlayOffer"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"offerDelete":{"post":{"summary":"offerDelete","description":"Triggered when an offer process is deleted","operationId":"offerDeleteWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["offerDelete"]},"data":{"type":"object","properties":{"offer":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"applicationId":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The id of the application the offer was associated with."}]}}}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"offerUpdate":{"post":{"summary":"offerUpdate","description":"Triggered when an offer is updated","operationId":"offerUpdateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["offerUpdate"]},"data":{"type":"object","properties":{"offer":{"$ref":"#/components/schemas/OverlayOffer"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"openingCreate":{"post":{"summary":"openingCreate","description":"Triggered when a opening is created","operationId":"openingCreateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["openingCreate"]},"data":{"type":"object","properties":{"opening":{"$ref":"#/components/schemas/OverlayOpening"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"pushToHRIS":{"post":{"summary":"pushToHRIS","description":"Triggered when a candidate is pushed to an HRIS system","operationId":"pushToHRISWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["pushToHRIS"]},"data":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/OverlayApplication"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"ping":{"post":{"summary":"ping","operationId":"pingWebhook","description":"Called to check that the webhook URL is live","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"type":"string","enum":["ping"]},"data":{"type":"object","properties":{"webhookActionType":{"description":"The type of action that triggered the webhook—in this case, a ping","type":"string","enum":["ping"]}},"required":["webhookActionType"]}},"required":["action","data"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"signatureRequestUpdate":{"post":{"summary":"signatureRequestUpdate","description":"Triggered on updates to requests for e-signatures: when requests are sent, cancelled, completed, or deleted.\n\nDepending on the type of request, additional context will be included in the webhook payload:\n  - **Offers** - `\"relatedEntityType\"` is `\"offer\"` and `\"offerId\"` is included.\n  - **Applications** - `\"relatedEntityType\"` is `\"application\"` and `\"applicationId\"` is included.\n","operationId":"signatureRequestUpdateWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["signatureRequestUpdate"]},"data":{"type":"object","oneOf":[{"title":"Application Payload","properties":{"relatedEntityType":{"type":"string","enum":["application"]},"applicationId":{"type":"string","format":"uuid"},"eventType":{"type":"string","enum":["sent","cancelled","completed","deleted"]}}},{"title":"Offer Payload","properties":{"relatedEntityType":{"type":"string","enum":["offer"]},"offerId":{"type":"string","format":"uuid"},"offerVersionId":{"type":"string","format":"uuid"},"eventType":{"type":"string","enum":["sent","cancelled","completed","deleted"]}}}]}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"surveySubmit":{"post":{"summary":"surveySubmit","description":"The webhook is triggered when a candidate submits a non-anonymous survey. It will not fire for anonymous survey submissions.\n\nDepending on the type of survey that was submitted, survey responses may be included in the webhook payload:\n  - **Questionnaires**, **Candidate Data Consent** - Survey responses will be included in the payload.\n  - **Candidate Experience** - If the submission is not anonymous, survey responses will be included in the payload. If the submission is anonymous, the webhook will not trigger.\n  - **Diversity Surveys**, **EEOC Surveys** - Survey responses will never be included in the payload.\n\nIf survey responses are included in the payload, the `submittedValues` field will contain the submitted answers in an object where each key is the path of the field and the value is the value submitted for that field.\n","operationId":"surveySubmitWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["surveySubmit"]},"data":{"type":"object","properties":{"surveySubmission":{"$ref":"#/components/schemas/OverlaySurveySubmission"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"takeHomeAssignmentAssigned":{"post":{"summary":"takeHomeAssignmentAssigned","description":"> Beta: This webhook may not be available for all organizations.\n\nThe webhook is called when a take-home assignment enters Waiting On Submission.","operationId":"takeHomeAssignmentAssignedWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["takeHomeAssignmentAssigned"]},"data":{"type":"object","properties":{"takeHomeAssignment":{"$ref":"#/components/schemas/OverlayTakeHomeAssignment"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"takeHomeAssignmentCancelled":{"post":{"summary":"takeHomeAssignmentCancelled","description":"> Beta: This webhook may not be available for all organizations.\n\nThe webhook is called when a take-home assignment is cancelled.","operationId":"takeHomeAssignmentCancelledWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["takeHomeAssignmentCancelled"]},"data":{"type":"object","properties":{"takeHomeAssignment":{"$ref":"#/components/schemas/OverlayTakeHomeAssignment"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"takeHomeAssignmentCompleted":{"post":{"summary":"takeHomeAssignmentCompleted","description":"> Beta: This webhook may not be available for all organizations.\n\nThe webhook is called when a take-home assignment is completed.","operationId":"takeHomeAssignmentCompletedWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["takeHomeAssignmentCompleted"]},"data":{"type":"object","properties":{"takeHomeAssignment":{"$ref":"#/components/schemas/OverlayTakeHomeAssignment"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}},"takeHomeAssignmentSubmitted":{"post":{"summary":"takeHomeAssignmentSubmitted","description":"> Beta: This webhook may not be available for all organizations.\n\nThe webhook is called when a candidate submits a take-home assignment and it enters Waiting On Feedback.","operationId":"takeHomeAssignmentSubmittedWebhook","tags":["Webhook Payloads"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["action","data"],"properties":{"action":{"type":"string","enum":["takeHomeAssignmentSubmitted"]},"data":{"type":"object","properties":{"takeHomeAssignment":{"$ref":"#/components/schemas/OverlayTakeHomeAssignment"}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}}},"components":{"schemas":{"BaseResponse":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"AssessmentListItem":{"type":"object","description":"List of available assessments","properties":{"assessment_type_id":{"allOf":[{"$ref":"#/components/schemas/id"}]},"name":{"type":"string"},"description":{"type":"string"}}},"OverlayErrorResponse":{"allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"title":"Error response"},{"type":"object","required":["errors","errorInfo"],"properties":{"errors":{"description":"A list of error codes","type":"array","items":{"type":"string"},"deprecated":true},"errorInfo":{"description":"A single error code and additional error information","type":"object","required":["code"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string","description":"Opaque identifier for the API request, which can be provided to Ashby support to help them diagnose the issue"},"meta":{"type":"object"}}}}}],"example":{"success":false,"errors":["invalid_input"],"errorInfo":{"code":"invalid_input","message":"Request payload is malformed","requestId":"01JSJ8FDK5ZN4XQBZP7DBKK7ZC"}}},"assessmentCandidate":{"type":"object","description":"A description of the candidate","required":["ashby_id","first_name","last_name","email","ashby_profile_url"],"properties":{"ashby_id":{"allOf":[{"type":"string"},{"description":"The identifier of the candidate in Ashby"}]},"first_name":{"allOf":[{"type":"string"},{"description":"The first name of the candidate being assessed"}]},"last_name":{"allOf":[{"type":"string"},{"description":"The last name of the candidate being assessed"}]},"email":{"allOf":[{"type":"string"},{"description":"The email of the candidate being assessed"}]},"ashby_profile_url":{"allOf":[{"type":"string"},{"description":"The url back into Ashby of the candidate being assessed"}]}}},"ApplicationStatus":{"type":"string","enum":["Hired","Archived","Active","Lead"]},"assessmentApplication":{"type":"object","description":"The application for which the candidate is being assessed","required":["ashby_id","status"],"properties":{"ashby_id":{"allOf":[{"type":"string"},{"description":"The id of the application in Ashby"}]},"status":{"allOf":[{"$ref":"#/components/schemas/ApplicationStatus"},{"description":"The status of the application in Ashby"}]}}},"email":{"type":"string","example":"test@ashbyhq.com"},"OverlayHiringTeamRole":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/email"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"$ref":"#/components/schemas/id"}},"required":["userId","firstName","lastName","email","role"]},"assessmentJob":{"type":"object","description":"The job for which the candidate is being assessed","required":["ashby_id","name","ashby_job_url"],"properties":{"ashby_id":{"allOf":[{"type":"string"},{"description":"The id of the job in Ashby"}]},"name":{"allOf":[{"type":"string"},{"description":"The name of the job in Ashby"}]},"req_id":{"allOf":[{"type":"string"},{"description":"The customer-defined requisition id for the job"}]},"ashby_job_url":{"allOf":[{"type":"string"},{"description":"The url of the job, internal to Ashby"}]},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/OverlayHiringTeamRole"}}}},"timestamp":{"type":"integer","description":"The timestamp in milliseconds since the unix epoch, when the update occurred","format":"int64","example":1665680638489},"assessmentType":{"type":"string","description":"The type of the value. Please reach out if you'd like us to support a new type!","enum":["numeric_score","numeric_duration_minutes","url","string","boolean_success"]},"assessmentValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"The raw value — one of string, number, or boolean\n"},"OverlayAssessmentDataValue":{"type":"object","properties":{"identifier":{"type":"string","description":"Uniquely identifies this field, for this partner","example":"result-max"},"label":{"type":"string","description":"Label for the assessment metadata to be displayed in the UI","example":"Max Score"},"description":{"type":"string","description":"Description of the assessment metadata, which may be displayed in the UI","example":"The maximum possible score for the assessment"},"type":{"$ref":"#/components/schemas/assessmentType"},"value":{"allOf":[{"$ref":"#/components/schemas/assessmentValue"},{"example":10}]}},"required":["identifier","label","type","value"]},"OverlayAssessmentUpdateRequest":{"type":"object","required":["assessment_id","timestamp"],"properties":{"assessment_id":{"allOf":[{"description":"Identifier of the assessment being updated"},{"$ref":"#/components/schemas/id"}]},"timestamp":{"$ref":"#/components/schemas/timestamp"},"assessment_status":{"allOf":[{"description":"The current status of the assessment. Setting this with a value of \"Started\" will signal Ashby to store the timestamp the assessment started. Required when `cancelled_reason` is not set."},{"$ref":"#/components/schemas/OverlayAssessmentDataValue"}]},"assessment_profile_url":{"allOf":[{"description":"The url back to the assessment/candidate on the partner's website. This value should always be of type url. Required when `assessment_result` is set."},{"$ref":"#/components/schemas/OverlayAssessmentDataValue"}]},"assessment_result":{"allOf":[{"description":"The result of the assessment. Sending an update with this field will signal to Ashby that the assessment is complete."},{"$ref":"#/components/schemas/OverlayAssessmentDataValue"}]},"cancelled_reason":{"allOf":[{"description":"The reason the assessment was cancelled. This field will signal to Ashby that the assessment is cancelled."},{"$ref":"#/components/schemas/OverlayAssessmentDataValue"}]},"metadata":{"type":"array","description":"Any other metadata about the assessment (e.g. ETA until complete). All assessment data should have unique identifiers.","items":{"$ref":"#/components/schemas/OverlayAssessmentDataValue"}}}},"AssessmentStartResponse":{"type":"object","required":["success","results"],"properties":{"success":{"type":"boolean"},"results":{"required":["assessment_id"],"properties":{"assessment_id":{"type":"string"},"update_request":{"$ref":"#/components/schemas/OverlayAssessmentUpdateRequest"}}}}},"AssessmentPartnerCustomField":{"type":"object","description":"A custom field specification provided by an assessment partner","additionalProperties":false,"properties":{"id":{"type":"string","minLength":1,"description":"Unique identifier for this custom field. This id will be used as the key in `additional_fields` when calling `/assessment.start`.","example":"department"},"name":{"type":"string","minLength":1,"description":"Display name of the custom field shown to users in Ashby","example":"Department"},"type":{"type":"string","description":"The type of the custom field","enum":["String","Date","DateRange","Number","ValueSelect","MultiValueSelect","Boolean","LongText","Email","Phone","Score","SocialLink","Url","Currency","Location"],"example":"ValueSelect"},"possible_values":{"type":"array","description":"Required for `ValueSelect` and `MultiValueSelect` types. An array of possible values the user can choose from.","items":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","minLength":1,"description":"Internal identifier for this option. This value will be sent in `additional_fields` when the assessment is started.","example":"eng"},"value":{"type":"string","minLength":1,"description":"Display value shown to users in Ashby","example":"Engineering"}},"required":["key","value"]}},"isRequired":{"type":"boolean","description":"Whether this field is required. Defaults to false if not specified.","example":false}},"required":["id","name","type"]},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"OverlayCustomField":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"isPrivate":{"type":"boolean","example":false},"title":{"type":"string"},"valueLabel":{"description":"The label of the custom field value. This is only present for value select custom fields.","oneOf":[{"type":"string","title":"String"},{"type":"array","title":"MultiValueSelect","items":{"type":"string"}}]},"value":{"oneOf":[{"type":"boolean","title":"Boolean"},{"type":"object","title":"Currency","properties":{"value":{"type":"number","example":1000000,"format":"currency"},"currencyCode":{"type":"string","example":"USD"}}},{"type":"string","title":"Date","format":"date-time"},{"type":"string","title":"String"},{"type":"string","title":"LongText"},{"type":"array","title":"MultiValueSelect","items":{"type":"string"}},{"type":"number","title":"Number"},{"type":"object","title":"NumberRange","properties":{"type":{"type":"string","example":"number-range"},"minValue":{"type":"number","example":10000},"maxValue":{"type":"number","example":100000}},"required":["type","minValue","maxValue"]},{"type":"object","title":"CompensationRange","properties":{"type":{"type":"string","example":"compensation-range"},"minValue":{"type":"number","example":40000},"maxValue":{"type":"number","example":50000},"currencyCode":{"type":"string","example":"USD"},"interval":{"type":"string","enum":["NONE","1 TIME","1 HOUR","1 DAY","1 WEEK","2 WEEK","1 MONTH","2 MONTH","1 YEAR","6 MONTH","0.5 MONTH","3 MONTH"],"example":"1 YEAR"}},"required":["type","minValue","maxValue","currencyCode","interval"]},{"type":"string","title":"ValueSelect"}]}},"required":["id","title","value"],"examples":[{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Is actively looking","value":true},{"id":"650e5f74-32db-4a0a-b61b-b9afece05024","title":"Years of experience","value":5},{"id":"650e5f74-32db-4a0a-b61b-b9afece05025","title":"Salary expectation","value":{"value":100000,"currencyCode":"USD"}},{"id":"650e5f74-32db-4a0a-b61b-b9afece05026","title":"Expected start date","value":"2022-11-10T19:47:56.795Z"}]},"OverlayContactInfo":{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"example":{"value":"test@ashbyhq.com","type":"Work","isPrimary":true}},"OverlayBaseInterviewStage":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"title":{"type":"string","example":"Offer"},"type":{"type":"string","example":"Offer"},"orderInInterviewPlan":{"type":"integer","example":1006,"default":0},"interviewStageGroupId":{"type":"string","example":"5f7b3b3b-7b1b-4b1b-8b3b-7b1b4b1b8b3b"}},"required":["id","title","type","orderInInterviewPlan"]},"OverlayInterviewStage":{"allOf":[{"$ref":"#/components/schemas/OverlayBaseInterviewStage"},{"type":"object","properties":{"interviewPlanId":{"$ref":"#/components/schemas/id"}},"required":["interviewPlanId"]}]},"isArchived":{"type":"boolean","example":false},"OverlaySourceType":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"title":{"type":"string","example":"Inbound"},"isArchived":{"$ref":"#/components/schemas/isArchived"}},"required":["id","title","isArchived"]},"OverlaySource":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"title":{"type":"string","example":"Applied"},"isArchived":{"$ref":"#/components/schemas/isArchived"},"sourceType":{"$ref":"#/components/schemas/OverlaySourceType"}},"required":["id","title","isArchived"]},"OverlayArchiveReason":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"$ref":"#/components/schemas/isArchived"}},"required":["id","text","reasonType","isArchived"]},"ArchiveDetails":{"allOf":[{"$ref":"#/components/schemas/OverlayArchiveReason"},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"$ref":"#/components/schemas/OverlayCustomField"}}},"required":["customFields"]}]},"OverlayUser":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"$ref":"#/components/schemas/email"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"$ref":"#/components/schemas/createdAt"},"managerId":{"description":"The user id of the user's manager","$ref":"#/components/schemas/id"},"customFields":{"type":"array","description":"Custom field values associated with the user. **Note:** This field requires a feature to be enabled for your organization. If it is not present in the response, please contact Ashby support to have it enabled.","items":{"$ref":"#/components/schemas/OverlayCustomField"}}},"required":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"OverlayApplication":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"createdAt":{"$ref":"#/components/schemas/createdAt"},"updatedAt":{"$ref":"#/components/schemas/createdAt"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/OverlayCustomField"}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"$ref":"#/components/schemas/id"},"name":{"type":"string","example":"James"},"primaryEmailAddress":{"$ref":"#/components/schemas/OverlayContactInfo"},"primaryPhoneNumber":{"allOf":[{"$ref":"#/components/schemas/OverlayContactInfo"},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"$ref":"#/components/schemas/OverlayInterviewStage"},"source":{"$ref":"#/components/schemas/OverlaySource"},"archiveReason":{"$ref":"#/components/schemas/ArchiveDetails"},"archivedAt":{"allOf":[{"$ref":"#/components/schemas/createdAt"},{"description":"The timestamp an application was archived"}]},"job":{"type":"object","properties":{"id":{"type":"string","example":"4071538b-3cac-4fbf-ac76-f78ed250ffdd"},"title":{"type":"string","example":"First Designer"},"locationId":{"$ref":"#/components/schemas/id"},"departmentId":{"$ref":"#/components/schemas/id"}},"required":["id","title"]},"creditedToUser":{"$ref":"#/components/schemas/OverlayUser"},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/OverlayHiringTeamRole"}},"appliedViaJobPostingId":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The id of the first job posting the candidate applied through. If the candidate submitted applications via multiple job postings for the same job, this will be the earliest one."}]},"submitterClientIp":{"type":"string","example":"79.255.55.222","description":"The IP address (can be v4 or v6) of the client that submitted the application, if it was submitted through the external job board."},"submitterUserAgent":{"type":"string","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36","description":"The user agent of the client that submitted the application, if it was submitted through the external job board."}},"required":["id","createdAt","updatedAt","candidate","status","currentInterviewStage","job","hiringTeam"]},"offerAcceptanceStatus":{"type":"string","enum":["Accepted","Declined","Pending","Created","Cancelled"]},"offerProcessStatus":{"type":"string","enum":["WaitingOnApprovalStart","WaitingOnOfferApproval","WaitingOnApprovalDefinition","WaitingOnCandidateResponse","CandidateRejected","CandidateAccepted","OfferCancelled"]},"OverlayFileHandle":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"handle":{"type":"string","description":"You can use the file handle to retrieve the file's URL by using the file.info endpoint."}},"required":["id","name","handle"],"example":{"id":"15d2624d-0a81-4f94-a2ed-94980f430b3f","name":"resume.pdf","handle":"eyJoYW5kbGUiOnsidHlwZSI6IkNhbmRpZGF0ZUZpbGUiLCJm"}},"offerApprovalStatus":{"type":["string","null"],"enum":["Approved","WaitingOnApprovals","Declined",null]},"OverlayOfferVersion":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"startDate":{"allOf":[{"$ref":"#/components/schemas/createdAt"},{"description":"The start date of the offer"}]},"salary":{"type":"object","properties":{"currencyCode":{"type":"string","description":"A valid ISO 4217 currency code"},"value":{"type":"number","description":"An integer. The salary specified by the offer."}}},"createdAt":{"allOf":[{"$ref":"#/components/schemas/createdAt"},{"description":"The time the offer was created"}]},"openingId":{"type":"string","description":"The id of the opening associated with the offer."},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/OverlayCustomField"}},"fileHandles":{"type":"array","description":"An array of file handles associated with the offer. If an offer letter has been generated, this array includes the file handles for the unsigned .pdf and .docx versions of the letter, as well as for the signed .pdf if it exists.","items":{"$ref":"#/components/schemas/OverlayFileHandle"}},"author":{"$ref":"#/components/schemas/OverlayUser"},"approvalStatus":{"allOf":[{"$ref":"#/components/schemas/offerApprovalStatus"},{"description":"The approval status of this offer version. Approved indicates this version has been approved. WaitingOnApprovals indicates approval is pending. Declined indicates this version was declined. This field is null when no approval process has been configured for the offer version."}]}},"required":["id","createdAt"]},"OfferBrief":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"decidedAt":{"type":"string"},"applicationId":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The id of the application associated with the offer"}]},"acceptanceStatus":{"allOf":[{"$ref":"#/components/schemas/offerAcceptanceStatus"},{"title":"AcceptanceStatus"}]},"offerStatus":{"allOf":[{"title":"OfferStatus"},{"$ref":"#/components/schemas/offerProcessStatus"}]},"latestVersion":{"$ref":"#/components/schemas/OverlayOfferVersion"}},"required":["id","applicationId","acceptanceStatus"]},"OverlayFormDefinition":{"type":"object","properties":{"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"descriptionHtml":{"type":"string"},"descriptionPlain":{"type":"string"},"fields":{"type":"array","items":{"type":"object","properties":{"isRequired":{"type":"boolean","example":true,"default":true},"descriptionHtml":{"type":"string"},"descriptionPlain":{"type":"string"},"field":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"type":{"type":"string","example":"String","description":"The type of the form definition field."},"path":{"type":"string","example":"_systemfield_name"},"humanReadablePath":{"type":"string","example":"Name"},"title":{"type":"string","example":"Name"},"isNullable":{"type":"boolean","example":false,"default":true},"selectableValues":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}}},"required":["id","type","path","humanReadablePath","title","isNullable"]}},"required":["isRequired","field"]}}},"required":["fields"]}}}},"OverlayOffer":{"allOf":[{"$ref":"#/components/schemas/OfferBrief"},{"type":"object","properties":{"versions":{"type":"array","items":{"$ref":"#/components/schemas/OverlayOfferVersion"}},"formDefinition":{"$ref":"#/components/schemas/OverlayFormDefinition"}}}]},"OverlayInterviewerPoolTrainingPathStage":{"type":"object","properties":{"id":{"allOf":[{"description":"The training stage's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"$ref":"#/components/schemas/id"}]},"interviewerRole":{"type":"string","enum":["Shadow","ReverseShadow"],"description":"The role of the interviewer for this stage","example":"Shadow"},"interviewsRequired":{"type":"integer","description":"The number of interviews required for this stage","example":2},"isArchived":{"type":"boolean","description":"Whether or not the training stage is archived","example":false},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/OverlayUser"}}},"required":["id","interviewerRole","interviewsRequired","isArchived","approvalRequired"]},"OverlayInterviewerPoolTrainingPath":{"type":"object","properties":{"id":{"allOf":[{"description":"The training path's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"$ref":"#/components/schemas/id"}]},"enabled":{"type":"boolean","description":"Whether or not the training path is enabled","example":true},"trainingStages":{"type":"array","items":{"$ref":"#/components/schemas/OverlayInterviewerPoolTrainingPathStage"}}},"required":["id","enabled","trainingStages"]},"OverlayInterviewerPoolBrief":{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"$ref":"#/components/schemas/id"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"$ref":"#/components/schemas/isArchived"},{"description":"Whether or not the pool is archived"}]},"trainingPath":{"$ref":"#/components/schemas/OverlayInterviewerPoolTrainingPath"}},"required":["id","title","isArchived"]},"OverlayInterviewerWithPoolUser":{"allOf":[{"$ref":"#/components/schemas/OverlayUser"},{"type":"object","description":"Represents an interviewer assigned to an InterviewEvent with their training role and pool information.","properties":{"trainingRole":{"type":["string","null"],"description":"The training-related role of the interviewer for this specific event. \nReturns null when the interviewer is qualified for interviewing (or Interviewer Training is not enabled). \nSee [Ashby Knowledge Base](https://docs.ashbyhq.com/interviewer-training) for more information.\n","enum":["Shadow","Reverse-Shadow"],"example":"Shadow"},"interviewerPool":{"anyOf":[{"$ref":"#/components/schemas/OverlayInterviewerPoolBrief"},{"type":"null"}],"description":"The interviewer pool this interviewer belongs to, if applicable."},"isFeedbackRequired":{"type":"boolean","description":"Whether feedback is required from this interviewer for this specific event."}}}],"required":["trainingRole","interviewerPool","isFeedbackRequired"]},"dateTime":{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"},"OverlayInterview":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"$ref":"#/components/schemas/id"}]},"title":{"type":"string","example":"Technical Phone Interview","description":"The interview's title"},"externalTitle":{"type":"string","example":"Technical Interview","description":"Alternate candidate-facing interview title displayed in email/interview communications.  If not specified, the primary title will be returned."},"isArchived":{"allOf":[{"$ref":"#/components/schemas/isArchived"},{"description":"Whether or not the interview is archived"}]},"isDebrief":{"type":"boolean","example":false,"description":"Whether the interview is a debrief"},"isFeedbackRequired":{"type":"boolean","example":true,"description":"Whether feedback is required by default for interviewers assigned to this interview"},"isFeedbackRequested":{"type":"boolean","example":true,"description":"Whether feedback is requested by default for interviewers assigned to this interview"},"instructionsHtml":{"type":"string","description":"An HTML version of the interview's description","example":"<p>The technical phone interview consists of a 60-minute series of technical questions</p>\n"},"instructionsPlain":{"type":"string","description":"A plaintext version of the interview's description","example":"The technical phone interview consists of a 60-minute series of technical questions"},"jobId":{"allOf":[{"description":"The id of the job the interview is associated with. If null, the interview is not associated with a specific job\nand is a shared interview. Interviews that are associated with particular jobs can only be scheduled for applications\nto those jobs.\n"},{"$ref":"#/components/schemas/id"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"$ref":"#/components/schemas/id"}]}},"required":["id","title","isArchived","isFeedbackRequired","isFeedbackRequested","feedbackFormDefinitionId"]},"extraData":{"type":"object","description":"This field stores information, structured as key-value pairs, for your own use and reference, for example a unique identifier for your own system.\nDo not store personally identifiable information (PII) in this field. In addition, the following constraints apply:\n- Keys must be strings of at most 100 characters.\n- Values must be strings of at most 512 characters.\n- The total size of the extra data must be less than 1kb.\n\nWe recommend using a prefix for your keys to avoid collisions with other systems, as data stored in this field is available to all API users with permission to access the underlying object.\n","additionalProperties":{"type":"string"},"example":{"partner_external_object_id":"12345","partner_additional_data":"f763ba0e4"}},"OverlayInterviewEvent":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The interview event's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"}]},"interviewId":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The interview's id"},{"example":"ff6c7d9d-71e3-4c9c-88b1-28824980c276"}]},"interviewScheduleId":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The interview schedule's id"},{"example":"9d34f544-c150-4d70-91c4-e8b0b4a72846"}]},"interviewerUserIds":{"type":"array","deprecated":true,"description":"An array of the ids of all interviewers. Use the `interviewers` field instead for more detailed information.","items":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"An array of the ids of all interviewers"},{"example":"caea4d97-331d-46b1-a8e3-6b821c2214ef"}]}},"interviewers":{"type":"array","description":"An array of user objects representing the interviewers on this event, including their training role and pool information.","items":{"$ref":"#/components/schemas/OverlayInterviewerWithPoolUser"}},"createdAt":{"allOf":[{"description":"The time the interview event was created"},{"$ref":"#/components/schemas/dateTime"}],"type":"string"},"updatedAt":{"allOf":[{"description":"The time the interview event was last updated"},{"$ref":"#/components/schemas/dateTime"}],"type":"string"},"startTime":{"allOf":[{"description":"The time the interview event is scheduled to start"},{"$ref":"#/components/schemas/dateTime"}],"type":"string"},"endTime":{"allOf":[{"description":"The time the interview event is scheduled to end"},{"$ref":"#/components/schemas/dateTime"}],"type":"string"},"feedbackLink":{"type":"string","format":"uri","example":"https://app.ashbyhq.com/interview-briefings/4736b6d2-5c97-43a6-a7c6-0228bf079411/feedback","description":"The link to submit feedback for the interview event"},"location":{"type":["string","null"],"description":"The location of the interview","example":"Google Meet"},"meetingLink":{"type":["string","null"],"format":"uri","description":"A link to the virtual meeting (if the interview is being hosted virtually)"},"interviewerCalendarEventId":{"type":["string","null"],"description":"The external calendar event id for the interviewer's calendar event"},"hasSubmittedFeedback":{"type":"boolean","description":"Whether or not this interview has any feedback submitted"},"interview":{"description":"The interview associated with this event (only included if the expand parameter includes \"interview\")","$ref":"#/components/schemas/OverlayInterview"},"notetakerTranscriptId":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The id of the AI notetaker transcript recording for this interview event, if one exists. Use with the notetakerTranscript.info endpoint to fetch transcript metadata and a download URL. This feature is in Beta.  Contact us to enable transcript API access for your organization."}],"type":["string","null"]},"extraData":{"$ref":"#/components/schemas/extraData"}},"required":["id","interviewId","interviewScheduleId","interviewers","createdAt","updatedAt","startTime","endTime","feedbackLink","hasSubmittedFeedback"]},"OverlayInterviewSchedule":{"type":"object","required":["id","status","applicationId","interviewStageId"],"properties":{"id":{"type":"string","description":"The id of the interview schedule"},"status":{"type":"string","enum":["NeedsScheduling","WaitingOnCandidateBooking","WaitingOnCandidateAvailability","CandidateAvailabilitySubmitted","Scheduled","WaitingOnFeedback","Complete","Cancelled","OnHold","Unknown"],"description":"The status of the interview schedule"},"applicationId":{"type":"string","description":"The id of the application associated with the interview schedule"},"interviewStageId":{"type":"string","description":"The id of the interview stage associated with the interview schedule"},"scheduledBy":{"description":"The user who scheduled this interview schedule. Null if the schedule has not been scheduled.","$ref":"#/components/schemas/OverlayUser"},"createdAt":{"type":"string","format":"date-time","description":"The time the interview schedule was created"},"updatedAt":{"type":"string","format":"date-time","description":"The time the interview schedule was last updated"},"interviewEvents":{"type":"array","description":"All scheduled interview events associated with the interview schedule","items":{"$ref":"#/components/schemas/OverlayInterviewEvent"}}}},"jobStatus":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"OverlayJob":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"$ref":"#/components/schemas/jobStatus"},"employmentType":{"$ref":"#/components/schemas/employmentType"},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"$ref":"#/components/schemas/id"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"$ref":"#/components/schemas/id"}]},"defaultInterviewPlanId":{"allOf":[{"description":"The id of the default interview plan for this job posting. \nA job cannot be opened without a default interview plan.\n"},{"$ref":"#/components/schemas/id"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The ids of all interview plans associated with a job"}]}},"customFields":{"type":"array","description":"An array of custom fields associated with the job","items":{"$ref":"#/components/schemas/OverlayCustomField"}},"jobPostingIds":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"$ref":"#/components/schemas/id"}]},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/OverlayHiringTeamRole"}},"author":{"$ref":"#/components/schemas/OverlayUser"},"createdAt":{"$ref":"#/components/schemas/createdAt"},"updatedAt":{"$ref":"#/components/schemas/createdAt"},"openedAt":{"$ref":"#/components/schemas/createdAt"},"closedAt":{"$ref":"#/components/schemas/createdAt"}},"required":["id","title","confidential","status","employmentType","updatedAt"]},"OverlayJobPostingLocationIds":{"type":"object","description":"An object containing the ids of all locations associated with the job posting","properties":{"primaryLocationId":{"$ref":"#/components/schemas/id"},"secondaryLocationIds":{"type":"array","items":{"$ref":"#/components/schemas/id"}}},"required":["primaryLocationId","secondaryLocationIds"]},"workplaceType":{"type":"string","enum":["OnSite","Hybrid","Remote"]},"OverlayJobPostingBrief":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The job posting's id"}]},"title":{"type":"string","example":"Posting Title","description":"The job posting's title"},"jobId":{"allOf":[{"$ref":"#/components/schemas/id"},{"description":"The id of the job associated with the job posting"}]},"departmentName":{"type":"string","example":"Engineering department","description":"The name of the department associated with the job posting"},"teamName":{"type":"string","example":"Data engineering team","description":"The name of the team associated with the job posting. `teamName` and `departmentName` will\nbe the same if the team does not have a parent team specified.\n"},"locationName":{"type":"string","example":"Springfield","description":"The name of the primary location associated with the job posting"},"locationIds":{"$ref":"#/components/schemas/OverlayJobPostingLocationIds"},"workplaceType":{"$ref":"#/components/schemas/workplaceType"},"employmentType":{"$ref":"#/components/schemas/employmentType"},"isListed":{"type":"boolean","example":true,"description":"Whether or not the job posting is listed"},"publishedDate":{"type":["string","null"],"example":"2021-11-19","description":"The date the job posting was published. Null for unpublished (draft) job postings."},"applicationDeadline":{"type":"string","example":"2024-08-12T20:00:00.000Z","format":"date-time","description":"The date and time when applications will no longer be accepted"},"externalLink":{"type":"string","example":"https://jobs.ashbyhq.com/6eec82ac-9713-512d-ac2e-405618935375/d5a6bc97-4259-4bc5-b3fe-6d3edfd538e3","description":"The external link to the job posting. Will be null if the job posting is on an internal job board."},"applyLink":{"type":"string","example":"https://jobs.ashbyhq.com/6eec82ac-9713-512d-ac2e-405618935375/d5a6bc97-4259-4bc5-b3fe-6d3edfd538e3","description":"The link to apply to the job posting. Will be to the public job board if the job posting is on an external job board, or to the internal job board if the job posting is on an internal job board."},"compensationTierSummary":{"type":"string","example":"$120K – $270K • 0% – 2.25% • Offers Bonus • Multiple Ranges","description":"A summary of *all* the job posting's valid compensation tiers in the same format shown on\nAshby-hosted Job Boards\n"},"shouldDisplayCompensationOnJobBoard":{"type":"boolean","example":true,"description":"Whether the job posting's settings specify that compensation should be shown to applicants\nwhen the posting is listed among other job postings\n"},"updatedAt":{"$ref":"#/components/schemas/createdAt"}},"required":["id","title","jobId","departmentName","teamName","locationName","locationIds","employmentType","isListed","publishedDate","applyLink","shouldDisplayCompensationOnJobBoard","updatedAt"]},"OverlayOpeningVersion":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"identifier":{"type":"string"},"description":{"type":"string"},"authorId":{"$ref":"#/components/schemas/id"},"createdAt":{"$ref":"#/components/schemas/createdAt"},"teamId":{"$ref":"#/components/schemas/id"},"jobIds":{"type":"array","items":{"$ref":"#/components/schemas/id"}},"targetHireDate":{"type":"string"},"targetStartDate":{"type":"string"},"isBackfill":{"type":"boolean"},"employmentType":{"$ref":"#/components/schemas/employmentType"},"locationIds":{"type":"array","items":{"$ref":"#/components/schemas/id"}},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/OverlayHiringTeamRole"}},"customFields":{"type":"array","description":"An array of custom fields associated with the opening","items":{"$ref":"#/components/schemas/OverlayCustomField"}}},"required":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"]},"OverlayOpening":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"openedAt":{"$ref":"#/components/schemas/createdAt"},"closedAt":{"$ref":"#/components/schemas/createdAt"},"isArchived":{"$ref":"#/components/schemas/isArchived"},"archivedAt":{"$ref":"#/components/schemas/createdAt"},"closeReasonId":{"$ref":"#/components/schemas/id"},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"]},"latestVersion":{"$ref":"#/components/schemas/OverlayOpeningVersion"}},"required":["id","isArchived","openingState"]},"surveyType":{"type":"string","enum":["CandidateDataConsent","CandidateExperience","Diversity","EEOC","Questionnaire"]},"OverlaySurveySubmission":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"surveyFormDefinitionId":{"description":"The id of the survey form definition that this submission is associated with. May be null if the survey form definition has been deleted.","oneOf":[{"$ref":"#/components/schemas/id"},{"type":"null"}]},"submittedAt":{"$ref":"#/components/schemas/createdAt"},"candidateId":{"allOf":[{"description":"The id of the candidate who submitted the survey"},{"$ref":"#/components/schemas/id"}]},"applicationId":{"allOf":[{"description":"The id of the application that the survey submission is associated with"},{"$ref":"#/components/schemas/id"}]},"surveyType":{"$ref":"#/components/schemas/surveyType"},"formDefinition":{"$ref":"#/components/schemas/OverlayFormDefinition"},"submittedValues":{"type":"object","example":{"_systemfield_name":"Gob Bluth"}}},"required":["id","submittedAt","candidateId","surveyType"]},"OverlayTakeHomeAssignment":{"type":"object","required":["id","applicationId","candidateId","status","createdAt","updatedAt","feedbackFormDefinitionId","reviewers"],"properties":{"id":{"type":"string","description":"The unique identifier for the take-home assignment"},"applicationId":{"type":"string","description":"The id of the associated application"},"candidateId":{"type":"string","description":"The id of the associated candidate"},"interviewStageId":{"type":"string","description":"The interview stage associated with the take-home assignment, if any. Null if none is associated."},"status":{"type":"string","enum":["WaitingOnSubmission","WaitingOnFeedback","Complete","Cancelled"],"description":"The current lifecycle status of the take-home assignment"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp when the take-home was created"},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp when the take-home was last updated"},"submission":{"description":"The candidate submission, or null until the candidate submits","type":"object","required":["id","submittedAt","fileHandles"],"properties":{"id":{"type":"string","description":"The unique identifier for the take-home submission"},"submittedAt":{"type":"string","format":"date-time","description":"The timestamp when the candidate submitted"},"notesHtml":{"type":"string","description":"The candidate's submission notes rendered as HTML, if provided"},"notesPlain":{"type":"string","description":"The candidate's submission notes rendered as plain text, if provided"},"fileHandles":{"type":"array","description":"File handles for submitted files. Resolve each handle with file.info.","items":{"$ref":"#/components/schemas/OverlayFileHandle"}}}},"feedbackFormDefinitionId":{"type":"string","description":"The feedback form definition reviewers use for this take-home"},"reviewers":{"type":"array","description":"The assigned take-home reviewers","items":{"type":"object","required":["userId","interviewEventId","feedbackLink","hasSubmittedFeedback"],"properties":{"userId":{"type":"string","description":"The id of the assigned reviewer"},"interviewEventId":{"type":"string","description":"The interview event id used for interview briefings and feedback submission"},"feedbackLink":{"type":"string","description":"The Ashby app link for submitting reviewer feedback"},"hasSubmittedFeedback":{"type":"boolean","description":"Whether this reviewer has submitted take-home feedback"},"feedbackSubmittedAt":{"type":"string","format":"date-time","description":"The timestamp when feedback was submitted, if it has been submitted. Null if not yet submitted."}}}}}},"ErrorDetail":{"type":"object","properties":{"message":{"type":"string"},"parameter":{"type":"string"}},"required":["message"],"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","const":false},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}},"required":["success","errors"],"additionalProperties":false},"ApiKey":{"type":"object","properties":{"title":{"type":"string","description":"The title of the API key."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the API key was created."},"scopes":{"type":"array","items":{"type":"string"},"description":"The permission scopes granted to the API key."}},"required":["title","createdAt","scopes"],"additionalProperties":false},"ApiKeyInfoRequest":{"type":"object","properties":{},"additionalProperties":false},"ApiKeyInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ApiKey"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"title":"Ashby Automator Bot","createdAt":"2024-01-15T10:30:00.000Z","scopes":["apiKeys:read","candidates:read"]}}},"FormFieldSelectableValue":{"type":"object","properties":{"label":{"type":"string","description":"The display label for the selectable value"},"value":{"type":"string","description":"The submitted value for the selectable option"}},"required":["label","value"],"additionalProperties":false},"FormDefinitionField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the form definition field"},"type":{"type":"string","description":"The type of the form definition field"},"path":{"type":"string","description":"The path used to submit values for this field"},"humanReadablePath":{"type":"string","description":"The human-readable path for the form field"},"title":{"type":"string","description":"The display title for the form field"},"isNullable":{"type":"boolean","description":"Whether the form field accepts null values"},"selectableValues":{"description":"The selectable options for select-type fields","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/FormFieldSelectableValue"}},{"type":"null"}]}},"required":["id","type","path","humanReadablePath","title","isNullable"],"additionalProperties":false},"FormDefinitionFieldEntry":{"type":"object","properties":{"isRequired":{"type":"boolean","description":"Whether this form field is required"},"descriptionHtml":{"description":"The field description formatted as HTML","anyOf":[{"type":"string"},{"type":"null"}]},"descriptionPlain":{"description":"The field description as plain text","anyOf":[{"type":"string"},{"type":"null"}]},"field":{"description":"The underlying field definition","$ref":"#/components/schemas/FormDefinitionField"}},"required":["isRequired","field"],"additionalProperties":false},"FormDefinitionSection":{"type":"object","properties":{"title":{"description":"The section title","anyOf":[{"type":"string"},{"type":"null"}]},"descriptionHtml":{"description":"The section description formatted as HTML","anyOf":[{"type":"string"},{"type":"null"}]},"descriptionPlain":{"description":"The section description as plain text","anyOf":[{"type":"string"},{"type":"null"}]},"fields":{"type":"array","items":{"$ref":"#/components/schemas/FormDefinitionFieldEntry"},"description":"The fields in this form section"}},"required":["fields"],"additionalProperties":false},"FormDefinition":{"type":"object","properties":{"sections":{"type":"array","items":{"$ref":"#/components/schemas/FormDefinitionSection"},"description":"The sections in the form definition"}},"required":["sections"],"additionalProperties":false},"GlobalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"],"description":"The user's global role in the organization","title":"Global Role"},"CustomField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"type":"boolean","description":"Whether the custom field is private"},"title":{"type":"string","description":"The title of the custom field"},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"object","properties":{"country":{"description":"The country of the location","type":"string"},"region":{"description":"The region of the location","type":"string"},"city":{"description":"The city of the location","type":"string"}},"additionalProperties":{}},{"type":"null"}],"description":"The value of the custom field"},"valueLabel":{"description":"The label of the custom field value. This is only present for value select custom fields.","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"null"}]}}]},{"type":"null"}]}},"required":["id","isPrivate","title","value"],"additionalProperties":false},"User":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}],"description":"The user's email address"},"globalRole":{"$ref":"#/components/schemas/GlobalRole"},"isEnabled":{"type":"boolean","description":"Whether the user is enabled (not deactivated)"},"updatedAt":{"type":"string","description":"The timestamp when the user was last updated (ISO 8601 format)"},"managerId":{"description":"The unique identifier for the user's manager","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customFields":{"description":"Custom fields associated with the user (only included when requested)","type":"array","items":{"$ref":"#/components/schemas/CustomField"}}},"required":["id","firstName","lastName","email","globalRole","isEnabled","updatedAt"],"additionalProperties":false},"HiringTeamRole":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier of the hiring team member"},"firstName":{"type":"string","description":"The first name of the hiring team member"},"lastName":{"type":"string","description":"The last name of the hiring team member"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The primary email address of the hiring team member"},"role":{"type":"string","description":"The hiring team role assigned to the member"}},"required":["userId","firstName","lastName","email","role"],"additionalProperties":false},"HiringTeamRemoveMemberRequest":{"type":"object","properties":{"applicationId":{"description":"The application to unassign the user role from","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"jobId":{"description":"The job to unassign the user role from","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"openingId":{"description":"The opening to unassign the user role from","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"teamMemberId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to unassign the role from","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"roleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the hiring team role to unassign from","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["teamMemberId","roleId"],"additionalProperties":false,"oneOf":[{"required":["applicationId"]},{"required":["jobId"]},{"required":["openingId"]}]},"HiringTeamAddMemberRequest":{"type":"object","properties":{"applicationId":{"description":"The application to assign the user a role on","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"jobId":{"description":"The job to assign the user a role on","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"openingId":{"description":"The opening to assign the user a role on","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"teamMemberId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to assign the role to","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"roleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the hiring team role to assign","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["teamMemberId","roleId"],"additionalProperties":false,"oneOf":[{"required":["applicationId"]},{"required":["jobId"]},{"required":["openingId"]}]},"HiringTeamRemoveMemberSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/HiringTeamRole"},"description":"The remaining hiring team roles after the member is removed"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"userId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","firstName":"Joey","lastName":"Joe","email":"joey.joe@example.com","role":"Hiring Manager"}]}},"HiringTeamAddMemberSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/HiringTeamRole"},"description":"The hiring team roles after the member is added"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"userId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","firstName":"Joey","lastName":"Joe","email":"joey.joe@example.com","role":"Hiring Manager"}]}},"Application":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the application was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the application was last updated"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"description":"Custom fields attached to the application, if any","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"}},{"type":"null"}]},"candidate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the candidate"},"name":{"type":"string","description":"The candidate's name"},"primaryEmailAddress":{"description":"The candidate's primary email address, if any","anyOf":[{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},{"type":"null"}]},"primaryPhoneNumber":{"description":"The candidate's primary phone number, if any","anyOf":[{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},{"type":"null"}]}},"required":["id","name"],"additionalProperties":false,"description":"The candidate associated with the application"},"currentInterviewStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview stage"},"title":{"type":"string","description":"The interview stage title"},"type":{"type":"string","description":"The interview stage type"},"orderInInterviewPlan":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The stage's order within its interview plan"},"interviewStageGroupId":{"description":"The id of the interview stage group the stage belongs to, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewPlanId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview plan the stage belongs to"}},"required":["id","title","type","orderInInterviewPlan","interviewPlanId"],"additionalProperties":false,"description":"The current interview stage for the application"},"source":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source's unique identifier"},"title":{"type":"string","description":"The title of the source"},"isArchived":{"type":"boolean","description":"Whether the source has been archived"},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source type's unique identifier"},"title":{"type":"string","description":"The title of the source type"},"isArchived":{"type":"boolean","description":"Whether the source type has been archived"}},"required":["id","title","isArchived"],"additionalProperties":false,"description":"The source type associated with this source"}},"required":["id","title","isArchived","sourceType"],"additionalProperties":false,"description":"The source attributed to this application, if any"},{"type":"null"}]},"archiveReason":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the archive reason"},"text":{"type":"string","description":"The display text for the archive reason"},"reasonType":{"type":"string","enum":["RejectedByCandidate","RejectedByOrg","Other"],"description":"The category of archive reason"},"isArchived":{"type":"boolean","description":"Whether the archive reason is archived"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"},"description":"Archive detail custom field values"}},"required":["id","text","reasonType","isArchived","customFields"],"additionalProperties":false,"description":"Details about the archive reason for this application, if archived"},{"type":"null"}]},"archivedAt":{"description":"The timestamp an application was archived","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"job":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the job"},"title":{"type":"string","description":"The job title"},"locationId":{"description":"The id of the job's primary location, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"departmentId":{"description":"The id of the job's department, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","title"],"additionalProperties":false,"description":"The job the application is for"},"creditedToUser":{"description":"The user the application is credited to","anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/HiringTeamRole"},"description":"The hiring team for the application"},"appliedViaJobPostingId":{"description":"The id of the first job posting the candidate applied through. If the candidate submitted applications via multiple job postings for the same job, this will be the earliest one.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"submitterClientIp":{"description":"The IP address (can be v4 or v6) of the client that submitted the application, if it was submitted through the external job board.","anyOf":[{"type":"string"},{"type":"null"}]},"submitterUserAgent":{"description":"The user agent of the client that submitted the application, if it was submitted through the external job board.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","createdAt","updatedAt","status","candidate","currentInterviewStage","job","hiringTeam"],"additionalProperties":false},"ApplicationHistory":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the history event"},"stageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview stage for this event"},"title":{"type":"string","description":"The interview stage title for this event"},"enteredStageAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp the application entered this stage"},"leftStageAt":{"description":"The timestamp the application left this stage, if any","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"stageNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The order of the history event in the application's history. 0 is the first event."},"allowedActions":{"type":"array","items":{"type":"string","enum":["none","delete","set_entered_at"]},"description":"Actions that can be performed on this history event via `application.updateHistory`."},"actorId":{"description":"The ID of the user that performed the stage change, if any.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","stageId","title","enteredStageAt","stageNumber","allowedActions"],"additionalProperties":false},"ApplicationCriteriaEvaluation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the criteria evaluation."},"criterion":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the criterion version."},"title":{"type":"string","description":"The title of the criterion."},"type":{"type":"string","enum":["ResumePrompt","DidAnswerApplicationFormQuestion","SimilarityToAiGeneratedAnswer"],"description":"The type of criterion evaluation."},"prompt":{"description":"The prompt text used for AI evaluation.","anyOf":[{"type":"string"},{"type":"null"}]},"applicationFormDefinitionId":{"description":"The id of the application form definition (if applicable).","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"applicationFormFieldPath":{"description":"The path to the specific application form field (if applicable).","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","title","type"],"additionalProperties":false,"description":"The criterion that was evaluated."},"status":{"type":"string","enum":["Pending","Completed","Failed","Skipped"],"description":"The status of the evaluation."},"outcome":{"description":"The evaluation outcome (e.g., \"Meets\", \"Does Not Meet\").","anyOf":[{"type":"string"},{"type":"null"}]},"reasoning":{"description":"The AI's reasoning for the evaluation outcome.","anyOf":[{"type":"string"},{"type":"null"}]},"skipReason":{"description":"The reason why the evaluation was skipped (if status is \"Skipped\").","anyOf":[{"type":"string"},{"type":"null"}]},"outcomeNumber":{"description":"A numerical score representing the evaluation outcome (0.0 to 1.0).","anyOf":[{"type":"number"},{"type":"null"}]},"evaluatedAt":{"description":"The date and time when the evaluation was completed.","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["id","criterion","status"],"additionalProperties":false},"ApplicationInfoResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the application was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the application was last updated"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"description":"Custom fields attached to the application, if any","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"}},{"type":"null"}]},"candidate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the candidate"},"name":{"type":"string","description":"The candidate's name"},"primaryEmailAddress":{"description":"The candidate's primary email address, if any","anyOf":[{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},{"type":"null"}]},"primaryPhoneNumber":{"description":"The candidate's primary phone number, if any","anyOf":[{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},{"type":"null"}]}},"required":["id","name"],"additionalProperties":false,"description":"The candidate associated with the application"},"currentInterviewStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview stage"},"title":{"type":"string","description":"The interview stage title"},"type":{"type":"string","description":"The interview stage type"},"orderInInterviewPlan":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The stage's order within its interview plan"},"interviewStageGroupId":{"description":"The id of the interview stage group the stage belongs to, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewPlanId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview plan the stage belongs to"}},"required":["id","title","type","orderInInterviewPlan","interviewPlanId"],"additionalProperties":false,"description":"The current interview stage for the application"},"source":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source's unique identifier"},"title":{"type":"string","description":"The title of the source"},"isArchived":{"type":"boolean","description":"Whether the source has been archived"},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source type's unique identifier"},"title":{"type":"string","description":"The title of the source type"},"isArchived":{"type":"boolean","description":"Whether the source type has been archived"}},"required":["id","title","isArchived"],"additionalProperties":false,"description":"The source type associated with this source"}},"required":["id","title","isArchived","sourceType"],"additionalProperties":false,"description":"The source attributed to this application, if any"},{"type":"null"}]},"archiveReason":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the archive reason"},"text":{"type":"string","description":"The display text for the archive reason"},"reasonType":{"type":"string","enum":["RejectedByCandidate","RejectedByOrg","Other"],"description":"The category of archive reason"},"isArchived":{"type":"boolean","description":"Whether the archive reason is archived"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"},"description":"Archive detail custom field values"}},"required":["id","text","reasonType","isArchived","customFields"],"additionalProperties":false,"description":"Details about the archive reason for this application, if archived"},{"type":"null"}]},"archivedAt":{"description":"The timestamp an application was archived","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"job":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the job"},"title":{"type":"string","description":"The job title"},"locationId":{"description":"The id of the job's primary location, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"departmentId":{"description":"The id of the job's department, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","title"],"additionalProperties":false,"description":"The job the application is for"},"creditedToUser":{"description":"The user the application is credited to","anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/HiringTeamRole"},"description":"The hiring team for the application"},"appliedViaJobPostingId":{"description":"The id of the first job posting the candidate applied through. If the candidate submitted applications via multiple job postings for the same job, this will be the earliest one.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"submitterClientIp":{"description":"The IP address (can be v4 or v6) of the client that submitted the application, if it was submitted through the external job board.","anyOf":[{"type":"string"},{"type":"null"}]},"submitterUserAgent":{"description":"The user agent of the client that submitted the application, if it was submitted through the external job board.","anyOf":[{"type":"string"},{"type":"null"}]},"openings":{"description":"The openings linked to the application. Only included when the request was made with `expand: ['openings']`.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the opening"},"openedAt":{"description":"The timestamp the opening was opened","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"closedAt":{"description":"The timestamp the opening was closed","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"isArchived":{"type":"boolean","description":"Whether the opening is archived"},"archivedAt":{"description":"The timestamp the opening was archived","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"closeReasonId":{"description":"The unique identifier for the close reason","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"],"description":"The current state of the opening"},"latestVersion":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the opening version"},"identifier":{"type":"string","description":"The human-readable opening identifier"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening description"},"authorId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The unique identifier for the author"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the opening version was created"},"teamId":{"description":"The unique identifier for the team","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The unique identifiers for jobs linked to the opening"},"targetHireDate":{"description":"The target hire date","anyOf":[{"type":"string"},{"type":"null"}]},"targetStartDate":{"description":"The target start date","anyOf":[{"type":"string"},{"type":"null"}]},"isBackfill":{"type":"boolean","description":"Whether the opening is a backfill"},"employmentType":{"type":"string","description":"The employment type"},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The location ids"},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The user id"},"firstName":{"type":"string","description":"The first name"},"lastName":{"type":"string","description":"The last name"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The email"},"role":{"type":"string","description":"The role"}},"required":["userId","firstName","lastName","email","role"],"additionalProperties":false},"description":"Hiring team for the opening"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"},"description":"Custom fields attached to the opening"}},"required":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"],"additionalProperties":false,"description":"The latest version of the opening"},{"type":"null"}]}},"required":["id","isArchived","openingState"],"additionalProperties":false,"description":"An opening linked to the application via `expand: ['openings']`"}},{"type":"null"}]},"applicationHistory":{"description":"The application's history events.","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ApplicationHistory"}},{"type":"null"}]},"applicationFormSubmissions":{"description":"Application form submissions. These match the response from the `applicationForm.submit` endpoint. Only included when the request was made with `expand: ['applicationFormSubmissions']`.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application form submission"},"formDefinition":{"description":"The form definition that was submitted","$ref":"#/components/schemas/FormDefinition"},"submittedValues":{"description":"The values submitted for the form, keyed by field path"}},"required":["id","formDefinition","submittedValues"],"additionalProperties":false}},{"type":"null"}]},"referrals":{"description":"Referrals for the application. Only included when the request was made with `expand: ['referrals']`.","anyOf":[{"type":"array","items":{"type":"object","properties":{"user":{"description":"The referring user","$ref":"#/components/schemas/User"},"referredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp the referral was created"}},"required":["user","referredAt"],"additionalProperties":false}},{"type":"null"}]},"resumeFileHandle":{"description":"The id, name and handle for the application's resume.","anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the file"},"name":{"type":"string","description":"The file name"},"handle":{"type":"string","description":"The file handle, which can be used with the `file.info` endpoint"}},"required":["id","name","handle"],"additionalProperties":false},{"type":"null"}]}},"required":["id","createdAt","updatedAt","status","candidate","currentInterviewStage","job","hiringTeam"],"additionalProperties":false},"ApplicationListResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the application was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the application was last updated"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"description":"Custom fields attached to the application, if any","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"}},{"type":"null"}]},"candidate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the candidate"},"name":{"type":"string","description":"The candidate's name"},"primaryEmailAddress":{"description":"The candidate's primary email address, if any","anyOf":[{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},{"type":"null"}]},"primaryPhoneNumber":{"description":"The candidate's primary phone number, if any","anyOf":[{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},{"type":"null"}]}},"required":["id","name"],"additionalProperties":false,"description":"The candidate associated with the application"},"currentInterviewStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview stage"},"title":{"type":"string","description":"The interview stage title"},"type":{"type":"string","description":"The interview stage type"},"orderInInterviewPlan":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The stage's order within its interview plan"},"interviewStageGroupId":{"description":"The id of the interview stage group the stage belongs to, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewPlanId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview plan the stage belongs to"}},"required":["id","title","type","orderInInterviewPlan","interviewPlanId"],"additionalProperties":false,"description":"The current interview stage for the application"},"source":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source's unique identifier"},"title":{"type":"string","description":"The title of the source"},"isArchived":{"type":"boolean","description":"Whether the source has been archived"},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source type's unique identifier"},"title":{"type":"string","description":"The title of the source type"},"isArchived":{"type":"boolean","description":"Whether the source type has been archived"}},"required":["id","title","isArchived"],"additionalProperties":false,"description":"The source type associated with this source"}},"required":["id","title","isArchived","sourceType"],"additionalProperties":false,"description":"The source attributed to this application, if any"},{"type":"null"}]},"archiveReason":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the archive reason"},"text":{"type":"string","description":"The display text for the archive reason"},"reasonType":{"type":"string","enum":["RejectedByCandidate","RejectedByOrg","Other"],"description":"The category of archive reason"},"isArchived":{"type":"boolean","description":"Whether the archive reason is archived"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"},"description":"Archive detail custom field values"}},"required":["id","text","reasonType","isArchived","customFields"],"additionalProperties":false,"description":"Details about the archive reason for this application, if archived"},{"type":"null"}]},"archivedAt":{"description":"The timestamp an application was archived","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"job":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the job"},"title":{"type":"string","description":"The job title"},"locationId":{"description":"The id of the job's primary location, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"departmentId":{"description":"The id of the job's department, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","title"],"additionalProperties":false,"description":"The job the application is for"},"creditedToUser":{"description":"The user the application is credited to","anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/HiringTeamRole"},"description":"The hiring team for the application"},"appliedViaJobPostingId":{"description":"The id of the first job posting the candidate applied through. If the candidate submitted applications via multiple job postings for the same job, this will be the earliest one.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"submitterClientIp":{"description":"The IP address (can be v4 or v6) of the client that submitted the application, if it was submitted through the external job board.","anyOf":[{"type":"string"},{"type":"null"}]},"submitterUserAgent":{"description":"The user agent of the client that submitted the application, if it was submitted through the external job board.","anyOf":[{"type":"string"},{"type":"null"}]},"openings":{"description":"The openings linked to the application. Only included when the request was made with `expand: ['openings']`.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the opening"},"openedAt":{"description":"The timestamp the opening was opened","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"closedAt":{"description":"The timestamp the opening was closed","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"isArchived":{"type":"boolean","description":"Whether the opening is archived"},"archivedAt":{"description":"The timestamp the opening was archived","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"closeReasonId":{"description":"The unique identifier for the close reason","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"],"description":"The current state of the opening"},"latestVersion":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the opening version"},"identifier":{"type":"string","description":"The human-readable opening identifier"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening description"},"authorId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The unique identifier for the author"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the opening version was created"},"teamId":{"description":"The unique identifier for the team","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The unique identifiers for jobs linked to the opening"},"targetHireDate":{"description":"The target hire date","anyOf":[{"type":"string"},{"type":"null"}]},"targetStartDate":{"description":"The target start date","anyOf":[{"type":"string"},{"type":"null"}]},"isBackfill":{"type":"boolean","description":"Whether the opening is a backfill"},"employmentType":{"type":"string","description":"The employment type"},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The location ids"},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The user id"},"firstName":{"type":"string","description":"The first name"},"lastName":{"type":"string","description":"The last name"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The email"},"role":{"type":"string","description":"The role"}},"required":["userId","firstName","lastName","email","role"],"additionalProperties":false},"description":"Hiring team for the opening"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"},"description":"Custom fields attached to the opening"}},"required":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"],"additionalProperties":false,"description":"The latest version of the opening"},{"type":"null"}]}},"required":["id","isArchived","openingState"],"additionalProperties":false,"description":"An opening linked to the application via `expand: ['openings']`"}},{"type":"null"}]}},"required":["id","createdAt","updatedAt","status","candidate","currentInterviewStage","job","hiringTeam"],"additionalProperties":false},"ApplicationUpdateHistoryResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the application was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the application was last updated"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"description":"Custom fields attached to the application, if any","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"}},{"type":"null"}]},"candidate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the candidate"},"name":{"type":"string","description":"The candidate's name"},"primaryEmailAddress":{"description":"The candidate's primary email address, if any","anyOf":[{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},{"type":"null"}]},"primaryPhoneNumber":{"description":"The candidate's primary phone number, if any","anyOf":[{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},{"type":"null"}]}},"required":["id","name"],"additionalProperties":false,"description":"The candidate associated with the application"},"currentInterviewStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview stage"},"title":{"type":"string","description":"The interview stage title"},"type":{"type":"string","description":"The interview stage type"},"orderInInterviewPlan":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The stage's order within its interview plan"},"interviewStageGroupId":{"description":"The id of the interview stage group the stage belongs to, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewPlanId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview plan the stage belongs to"}},"required":["id","title","type","orderInInterviewPlan","interviewPlanId"],"additionalProperties":false,"description":"The current interview stage for the application"},"source":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source's unique identifier"},"title":{"type":"string","description":"The title of the source"},"isArchived":{"type":"boolean","description":"Whether the source has been archived"},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source type's unique identifier"},"title":{"type":"string","description":"The title of the source type"},"isArchived":{"type":"boolean","description":"Whether the source type has been archived"}},"required":["id","title","isArchived"],"additionalProperties":false,"description":"The source type associated with this source"}},"required":["id","title","isArchived","sourceType"],"additionalProperties":false,"description":"The source attributed to this application, if any"},{"type":"null"}]},"archiveReason":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the archive reason"},"text":{"type":"string","description":"The display text for the archive reason"},"reasonType":{"type":"string","enum":["RejectedByCandidate","RejectedByOrg","Other"],"description":"The category of archive reason"},"isArchived":{"type":"boolean","description":"Whether the archive reason is archived"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"},"description":"Archive detail custom field values"}},"required":["id","text","reasonType","isArchived","customFields"],"additionalProperties":false,"description":"Details about the archive reason for this application, if archived"},{"type":"null"}]},"archivedAt":{"description":"The timestamp an application was archived","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"job":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the job"},"title":{"type":"string","description":"The job title"},"locationId":{"description":"The id of the job's primary location, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"departmentId":{"description":"The id of the job's department, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","title"],"additionalProperties":false,"description":"The job the application is for"},"creditedToUser":{"description":"The user the application is credited to","anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/HiringTeamRole"},"description":"The hiring team for the application"},"appliedViaJobPostingId":{"description":"The id of the first job posting the candidate applied through. If the candidate submitted applications via multiple job postings for the same job, this will be the earliest one.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"submitterClientIp":{"description":"The IP address (can be v4 or v6) of the client that submitted the application, if it was submitted through the external job board.","anyOf":[{"type":"string"},{"type":"null"}]},"submitterUserAgent":{"description":"The user agent of the client that submitted the application, if it was submitted through the external job board.","anyOf":[{"type":"string"},{"type":"null"}]},"openings":{"description":"The openings linked to the application. Only included when the request was made with `expand: ['openings']`.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the opening"},"openedAt":{"description":"The timestamp the opening was opened","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"closedAt":{"description":"The timestamp the opening was closed","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"isArchived":{"type":"boolean","description":"Whether the opening is archived"},"archivedAt":{"description":"The timestamp the opening was archived","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"closeReasonId":{"description":"The unique identifier for the close reason","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"],"description":"The current state of the opening"},"latestVersion":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the opening version"},"identifier":{"type":"string","description":"The human-readable opening identifier"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening description"},"authorId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The unique identifier for the author"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the opening version was created"},"teamId":{"description":"The unique identifier for the team","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The unique identifiers for jobs linked to the opening"},"targetHireDate":{"description":"The target hire date","anyOf":[{"type":"string"},{"type":"null"}]},"targetStartDate":{"description":"The target start date","anyOf":[{"type":"string"},{"type":"null"}]},"isBackfill":{"type":"boolean","description":"Whether the opening is a backfill"},"employmentType":{"type":"string","description":"The employment type"},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The location ids"},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The user id"},"firstName":{"type":"string","description":"The first name"},"lastName":{"type":"string","description":"The last name"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The email"},"role":{"type":"string","description":"The role"}},"required":["userId","firstName","lastName","email","role"],"additionalProperties":false},"description":"Hiring team for the opening"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false},{"type":"null"}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false,"description":"A custom field value attached to the application"},"description":"Custom fields attached to the opening"}},"required":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"],"additionalProperties":false,"description":"The latest version of the opening"},{"type":"null"}]}},"required":["id","isArchived","openingState"],"additionalProperties":false,"description":"An opening linked to the application via `expand: ['openings']`"}},{"type":"null"}]},"applicationHistory":{"description":"The application's history events.","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ApplicationHistory"}},{"type":"null"}]},"applicationFormSubmissions":{"description":"Application form submissions. These match the response from the `applicationForm.submit` endpoint. Only included when the request was made with `expand: ['applicationFormSubmissions']`.","anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application form submission"},"formDefinition":{"description":"The form definition that was submitted","$ref":"#/components/schemas/FormDefinition"},"submittedValues":{"description":"The values submitted for the form, keyed by field path"}},"required":["id","formDefinition","submittedValues"],"additionalProperties":false}},{"type":"null"}]},"referrals":{"description":"Referrals for the application. Only included when the request was made with `expand: ['referrals']`.","anyOf":[{"type":"array","items":{"type":"object","properties":{"user":{"description":"The referring user","$ref":"#/components/schemas/User"},"referredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp the referral was created"}},"required":["user","referredAt"],"additionalProperties":false}},{"type":"null"}]}},"required":["id","createdAt","updatedAt","status","candidate","currentInterviewStage","job","hiringTeam"],"additionalProperties":false},"ApplicationDeleteRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application to delete","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["applicationId"],"additionalProperties":false},"ApplicationRemoveHiringTeamMemberRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The application to unassign the user a role from.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"teamMemberId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to unassign the role from.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"roleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the hiring team role to unassign.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["applicationId","teamMemberId","roleId"],"additionalProperties":false},"ApplicationAddHiringTeamMemberRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The application to assign the user a role on.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"teamMemberId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to assign the role to.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"roleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the hiring team role to assign.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["applicationId","teamMemberId","roleId"],"additionalProperties":false},"ApplicationChangeSourceRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application to update the source of.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"sourceId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The source to set on the application. Pass `null` to unset an application's source.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["applicationId","sourceId"],"additionalProperties":false},"ApplicationChangeStageRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application to update the stage of.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewStageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The interview stage to move the application to.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"archiveReasonId":{"description":"Archive Reason to set when moving to an Interview Stage with type `Archived`. Required when moving to an `Archived` stage.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"archiveEmail":{"anyOf":[{"type":"object","properties":{"communicationTemplateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the communication template to use for the email. Note: This communication template's `intendedTypes` must include `email`.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"sendAt":{"description":"The date and time to send the email as an ISO 8601 date and time string. Defaults to the following morning at 9:32am in your default timezone if not provided. If the time is in the past the email is sent immediately. Timestamps without an explicit timezone are interpreted as UTC.","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["communicationTemplateId"],"additionalProperties":false,"description":"Email to send to the candidate when moving the application to an `Archived` interview stage."},{"type":"null"}]}},"required":["applicationId","interviewStageId"],"additionalProperties":false},"ApplicationCreateRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to consider for a job.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job to consider the candidate for.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewPlanId":{"description":"The id of the interview plan to place the application in. If none is provided, the default interview plan is used.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewStageId":{"description":"The interview stage of the interview plan to place the application in. If none is provided, the application is placed in the first \"Lead\" stage. You can also supply the special string \"FirstPreInterviewScreen\", which selects the first pre-interview-screen stage on the job's interview plan.","anyOf":[{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","const":"FirstPreInterviewScreen"}]},{"type":"null"}]},"sourceId":{"description":"The source to set on the application being created.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"creditedToUserId":{"description":"The id of the user the application will be credited to.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAt":{"description":"An ISO date string to set the application's `createdAt` timestamp. Defaults to the time the call was made when not provided.","example":"2022-08-12T20:29:56.964Z","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"applicationHistory":{"description":"An array of objects representing the application history. When provided, the application is created with the supplied history events.","anyOf":[{"type":"array","items":{"type":"object","properties":{"stageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview stage for this history event. Must belong to the application's interview plan.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"stageNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The sort order of this event. 0 is the first, the highest number will be the current stage."},"enteredStageAt":{"description":"An ISO date string representing the time the application entered this stage.","example":"2022-07-21T17:32:28Z","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"applicationHistoryId":{"description":"The id of the application history event to update. Required when updating an existing event; omit for new events.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"archiveReasonId":{"description":"The id of the archive reason. Required when the interview stage is of type `Archived`.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["stageId","stageNumber","enteredStageAt"],"additionalProperties":false,"description":"An application history event."}},{"type":"null"}]}},"required":["candidateId","jobId"],"additionalProperties":false},"ApplicationUpdateRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application to update.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"sourceId":{"description":"The source to set on the application.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"creditedToUserId":{"description":"The id of the user the application will be credited to.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAt":{"description":"An ISO date string to set the application's `createdAt` timestamp. When provided, the first history event's `enteredStageAt` is updated to match.","example":"2022-08-12T20:29:56.964Z","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"sendNotifications":{"description":"Whether users subscribed to the application should be notified that the application was updated. Defaults to `true`.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["applicationId"],"additionalProperties":false},"ApplicationInfoRequest":{"type":"object","properties":{"applicationId":{"description":"The id of the application to fetch.","anyOf":[{"type":"string"},{"type":"null"}]},"submittedFormInstanceId":{"description":"The id of the application's submitted form instance to fetch. Either `applicationId` or `submittedFormInstanceId` must be provided. When both are supplied, the lookup uses `applicationId`.","anyOf":[{"type":"string"},{"type":"null"}]},"expand":{"description":"Choose to expand the result and include additional data for related objects.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"additionalProperties":false},"ApplicationListRequest":{"type":"object","properties":{"syncToken":{"description":"A sync token to retrieve only applications updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of applications to return per page.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]},"createdAfter":{"description":"Unix timestamp (milliseconds). When provided, only applications created at or after this time are returned. Must not be later than createdBefore or in the future.","anyOf":[{"type":"number"},{"type":"null"}]},"createdBefore":{"description":"Unix timestamp (milliseconds). When provided, only applications created at or before this time are returned. Must not be in the future.","anyOf":[{"type":"number"},{"type":"null"}]},"status":{"description":"Filter applications by status. Comparison is case-insensitive against `Hired`, `Archived`, `Active`, `Lead`.","anyOf":[{"type":"string"},{"type":"null"}]},"jobId":{"description":"Only return applications for the job with the supplied id.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"expand":{"description":"Choose to expand the result and include additional data for related objects.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"additionalProperties":false},"ApplicationListHistoryRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application to fetch.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of history events to return per page.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["applicationId"],"additionalProperties":false},"ApplicationListCriteriaEvaluationsRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application to fetch criteria evaluations for.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of criteria evaluations to return per page.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["applicationId"],"additionalProperties":false},"ApplicationTransferRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application to transfer.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job to transfer the application to.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewPlanId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview plan to transfer the application to.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewStageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The interview stage of the interview plan to transfer the application to.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"startAutomaticActivities":{"description":"Whether to start any automatic activities set on the target interview stage. Defaults to `true` when omitted.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["applicationId","jobId","interviewPlanId","interviewStageId"],"additionalProperties":false},"ApplicationUpdateHistoryRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application whose history to update.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationHistory":{"minItems":1,"type":"array","items":{"type":"object","properties":{"stageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview stage for this history event. Must belong to the application's interview plan.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"stageNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The sort order of this event. 0 is the first, the highest number will be the current stage."},"enteredStageAt":{"description":"An ISO date string representing the time the application entered this stage.","example":"2022-07-21T17:32:28Z","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},"applicationHistoryId":{"description":"The id of the application history event to update. Required when updating an existing event; omit for new events.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"archiveReasonId":{"description":"The id of the archive reason. Required when the interview stage is of type `Archived`.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["stageId","stageNumber","enteredStageAt"],"additionalProperties":false,"description":"An application history event."},"description":"The updated array of application history events. This array should contain all history events for the application, not just the events being updated."}},"required":["applicationId","applicationHistory"],"additionalProperties":false},"ApplicationDeleteResult":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application that was deleted","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["applicationId"],"additionalProperties":false},"ApplicationDeleteSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ApplicationDeleteResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"applicationId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"ApplicationRemoveHiringTeamMemberSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/HiringTeamRole"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"userId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","firstName":"Joey","lastName":"Joe","email":"joey.joe@example.com","role":"Hiring Manager"}}},"ApplicationAddHiringTeamMemberSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/HiringTeamRole"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"userId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","firstName":"Joey","lastName":"Joe","email":"joey.joe@example.com","role":"Hiring Manager"}}},"ApplicationChangeSourceSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Application"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"ApplicationChangeStageSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Application"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"ApplicationCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Application"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"ApplicationUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Application"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"ApplicationTransferSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Application"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"ApplicationInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ApplicationInfoResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"ApplicationUpdateHistorySuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ApplicationUpdateHistoryResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"ApplicationListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationListResult"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":null,"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"ApplicationListHistorySuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationHistory"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"0d7f1d4e-cdb1-4d72-9c1d-9b1d4d72e0bd","stageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","enteredStageAt":"2024-01-15T10:30:00.000Z","leftStageAt":null,"stageNumber":0,"allowedActions":["delete","set_entered_at"],"actorId":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"ApplicationListCriteriaEvaluationsSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationCriteriaEvaluation"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"a4d6d2f0-9b8f-4f0a-8b1a-1f6f7d3c2d1e","criterion":{"id":"9b2cb8d9-1a6b-4d4f-9c5d-69ef7b9a9f12","title":"Location","type":"ResumePrompt","prompt":"Evaluate if the candidate's location aligns with the job requirements.","applicationFormDefinitionId":null,"applicationFormFieldPath":null},"status":"Completed","outcome":"Meets","reasoning":"The candidate's location in San Francisco aligns well with the job's requirement for Bay Area presence.","skipReason":null,"outcomeNumber":0.85,"evaluatedAt":"2024-01-15T10:30:00.000Z"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"FormSubmissionInstance":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the submitted form instance"},"formDefinition":{"description":"The form definition that was submitted","$ref":"#/components/schemas/FormDefinition"},"submittedValues":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Submitted values keyed by the corresponding form field path"}},"required":["id","formDefinition","submittedValues"],"additionalProperties":false},"ApplicationFeedback":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application feedback"},"formDefinition":{"description":"The form definition that was submitted","$ref":"#/components/schemas/FormDefinition"},"feedbackFormDefinitionId":{"description":"The id of the feedback form definition associated with this feedback","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application this feedback was submitted for"},"submittedValues":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Submitted values keyed by the corresponding form field path"},"submittedByUser":{"description":"The user who submitted the feedback","$ref":"#/components/schemas/User"},"creditedToUser":{"description":"The user the feedback is attributed to. For interview feedback, this is the interviewer whose assignment the feedback was submitted for.","$ref":"#/components/schemas/User"},"interviewId":{"description":"The id of the interview associated with this feedback, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewEventId":{"description":"The id of the interview event associated with this feedback, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"applicationHistoryId":{"description":"The id of the application history entry associated with this feedback, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"submittedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The time when this feedback was submitted"}},"required":["id","formDefinition","applicationId","submittedValues","submittedByUser","creditedToUser","submittedAt"],"additionalProperties":false},"ApplicationFeedbackSubmitRequest":{"type":"object","properties":{"feedbackForm":{"type":"object","properties":{"fieldSubmissions":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The form field \"path\" value"},"value":{"description":"The submitted value. The accepted shape depends on the type of field being submitted.\n- Score field: An object in the format `{ score: 4 }` where `score` is an integer between 1 and 4 inclusive. Optionally include `comments` as plain text: `{ score: 4, comments: { type: \"PlainText\", value: \"A plain text string\" } }`.\n- Location field: An object with the following properties: `{ country: \"USA\", city: \"San Francisco\", region: \"California\" }`. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties."}},"required":["path","value"],"additionalProperties":{}},"description":"The submitted values for the feedback form fields"}},"required":["fieldSubmissions"],"additionalProperties":{},"description":"The application feedback form data containing field submissions"},"formDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the feedback form definition associated with the form submission","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application you're submitting feedback for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"userId":{"description":"The id of the user the feedback will be credited to. If omitted, the feedback will be credited to the API key user.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewEventId":{"description":"The id of the interview event you're submitting feedback for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["feedbackForm","formDefinitionId","applicationId"],"additionalProperties":{}},"ApplicationFeedbackSubmitResult":{"type":"object","properties":{"submittedFormInstance":{"description":"The submitted feedback form","$ref":"#/components/schemas/FormSubmissionInstance"}},"required":["submittedFormInstance"],"additionalProperties":false},"ApplicationFeedbackSubmitSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ApplicationFeedbackSubmitResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"submittedFormInstance":{"id":"0209ec12-0611-4c74-8b86-2cce35acfc46","formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"dbf36925-0161-4f40-8a04-fcb49e5bbdb0","type":"ValueSelect","path":"overall_recommendation","humanReadablePath":"Overall Recommendation","title":"Overall Recommendation","isNullable":false,"selectableValues":[{"label":"4 - Strong Yes","value":"4"},{"label":"3 - Yes","value":"3"},{"label":"2 - No","value":"2"},{"label":"1 - Strong No","value":"1"}]}}]}]},"submittedValues":{"overall_recommendation":"3"}}}}},"ApplicationFeedbackListRequest":{"type":"object","properties":{"applicationId":{"description":"The id of the application you'd like to fetch feedback for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return per page. The maximum and default value is 100.","example":25,"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only feedback updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"description":"Unix timestamp (milliseconds). When provided, only feedback created at or after this time is returned.","example":1659979196538,"anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"ApplicationFeedbackListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationFeedback"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","applicationId":"550e8400-e29b-41d4-a716-446655440000","feedbackFormDefinitionId":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","interviewId":"6ba7b811-9dad-11d1-80b4-00c04fd430c8","interviewEventId":"6ba7b812-9dad-11d1-80b4-00c04fd430c8","submittedAt":"2023-11-15T14:30:00.000Z","submittedByUser":{"id":"123e4567-e89b-12d3-a456-426614174000","firstName":"Sarah","lastName":"Johnson","email":"sarah.johnson@company.com","globalRole":"Elevated Access","isEnabled":true,"updatedAt":"2023-11-15T14:30:00.000Z"},"creditedToUser":{"id":"3f60c5d3-37bd-44fd-b941-97082c04a496","firstName":"Michael","lastName":"Bluth","email":"michael.bluth@company.com","globalRole":"Limited Access","isEnabled":true,"updatedAt":"2023-11-15T14:30:00.000Z"},"formDefinition":{"sections":[{"title":"Technical Assessment","fields":[{"isRequired":true,"field":{"id":"550e8400-e29b-41d4-a716-446655440001","type":"ValueSelect","path":"overall_recommendation","title":"Overall Recommendation","humanReadablePath":"Overall Recommendation","isNullable":false,"selectableValues":[{"label":"Strong Hire","value":"strong_hire"},{"label":"Hire","value":"hire"},{"label":"No Hire","value":"no_hire"}]}}]}]},"submittedValues":{"overall_recommendation":"hire"}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"ApplicationFeedbackRequest":{"type":"object","properties":{"interviewEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview event created without scheduling","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewerUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user whose feedback was requested","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application feedback was requested for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewEventId","interviewerUserId","applicationId"],"additionalProperties":false},"ApplicationFeedbackRequestCreateRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application you are requesting feedback for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview associated with this feedback request","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewerUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The user you are requesting feedback from","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["applicationId","interviewId","interviewerUserId"],"additionalProperties":false},"ApplicationFeedbackRequestCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ApplicationFeedbackRequest"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"interviewEventId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","interviewerUserId":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","applicationId":"550e8400-e29b-41d4-a716-446655440000"}}},"ApplicationFormSubmitRequest":{"type":"object","properties":{"jobPostingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job posting to submit the application for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationForm":{"type":"object","properties":{"fieldSubmissions":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The path of the application form field being submitted"},"value":{"description":"The value to submit for the application form field"}},"required":["path","value"],"additionalProperties":{}},"description":"The list of field values to submit for the application form"}},"required":["fieldSubmissions"],"additionalProperties":{},"description":"The application form data containing field submissions"},"utmData":{"description":"Optional UTM tracking data","anyOf":[{"type":"object","properties":{"utm_source":{"description":"The source UTM parameter for the application","anyOf":[{"type":"string"},{"type":"null"}]},"utm_medium":{"description":"The medium UTM parameter for the application","anyOf":[{"type":"string"},{"type":"null"}]},"utm_campaign":{"description":"The campaign UTM parameter for the application","anyOf":[{"type":"string"},{"type":"null"}]},"utm_term":{"description":"The term UTM parameter for the application","anyOf":[{"type":"string"},{"type":"null"}]},"utm_content":{"description":"The content UTM parameter for the application","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"tagIds":{"description":"Optional array of tag ids to apply to the candidate","anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of a candidate tag to apply"}},{"type":"null"}]},"allowSubmissionForUnpublishedJobPosting":{"default":true,"description":"If false, applications for unpublished job postings will be rejected. Defaults to true.","example":true,"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["jobPostingId","applicationForm","allowSubmissionForUnpublishedJobPosting"],"additionalProperties":{}},"ApplicationFormField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the form field","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"type":{"type":"string","description":"The type of form field"},"path":{"type":"string","description":"The field path used when submitting values"},"humanReadablePath":{"type":"string","description":"The human-readable field path"},"title":{"type":"string","description":"The display title of the form field"},"isNullable":{"type":"boolean","description":"Whether the field accepts a null value"},"selectableValues":{"description":"The selectable values for fields with a fixed set of options","anyOf":[{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The display label for the selectable field value"},"value":{"type":"string","description":"The submitted value for the selectable field option"}},"required":["label","value"],"additionalProperties":false}},{"type":"null"}]}},"required":["id","type","path","humanReadablePath","title","isNullable"],"additionalProperties":false},"ApplicationFormDefinitionField":{"type":"object","properties":{"isRequired":{"type":"boolean","description":"Whether the field is required before submission"},"field":{"description":"The form field definition","$ref":"#/components/schemas/ApplicationFormField"},"descriptionHtml":{"description":"The field description rendered as HTML, when present","anyOf":[{"type":"string"},{"type":"null"}]},"descriptionPlain":{"description":"The field description rendered as plain text, when present","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["isRequired","field"],"additionalProperties":false},"ApplicationFormSection":{"type":"object","properties":{"title":{"description":"The section title, when present","anyOf":[{"type":"string"},{"type":"null"}]},"descriptionHtml":{"description":"The section description rendered as HTML, when present","anyOf":[{"type":"string"},{"type":"null"}]},"descriptionPlain":{"description":"The section description rendered as plain text, when present","anyOf":[{"type":"string"},{"type":"null"}]},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationFormDefinitionField"},"description":"The fields contained in the section"}},"required":["fields"],"additionalProperties":false},"ApplicationFormDefinition":{"type":"object","properties":{"sections":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationFormSection"},"description":"The sections in the form"}},"required":["sections"],"additionalProperties":false},"ApplicationFormSubmittedFormInstance":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the submitted form instance","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"formDefinition":{"description":"The form definition that was submitted","$ref":"#/components/schemas/ApplicationFormDefinition"},"submittedValues":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"The submitted values keyed by application form field path"}},"required":["id","formDefinition","submittedValues"],"additionalProperties":false},"ApplicationFormSubmitResult":{"type":"object","properties":{"submittedFormInstance":{"description":"The submitted form instance","$ref":"#/components/schemas/ApplicationFormSubmittedFormInstance"},"formMessages":{"type":"object","properties":{"blocked":{"type":"boolean","description":"Whether the application was blocked by a blocking rule"},"blockMessageForCandidateHtml":{"description":"The HTML message shown to the candidate when the application is blocked","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["blocked"],"additionalProperties":false,"description":"Messages associated with the form submission"}},"required":["submittedFormInstance","formMessages"],"additionalProperties":false},"ApplicationFormSubmitSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ApplicationFormSubmitResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"submittedFormInstance":{"id":"7a3d9986-a88a-49f4-b363-8da21b893e30","formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"e7a0d858-963f-4964-b268-5271ad20dd59","type":"String","path":"_systemfield_name","humanReadablePath":"Name","title":"Name","isNullable":false}}]}]},"submittedValues":{"_systemfield_name":"Zod Baseline Applicant"}},"formMessages":{"blocked":false}}}},"ApplicationHiringTeamRole":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the application hiring team role"},"title":{"type":"string","description":"The title of the application hiring team role"}},"required":["id","title"],"additionalProperties":false},"ApplicationHiringTeamRoleListRequest":{"type":"object","properties":{},"additionalProperties":false},"ApplicationHiringTeamRoleListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationHiringTeamRole"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Hiring Manager"}]}},"ApprovalStepApprover":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the approval step approver"},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of a user who is an approver for this step"},"decision":{"type":"string","enum":["approve","reject","pending"],"description":"The approver's decision for this approval step"},"decidedAt":{"description":"The date and time when the decision was taken by the user","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"requestedAt":{"description":"The date and time when the approval request was sent to the user","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["id","userId","decision"],"additionalProperties":false},"ApprovalStep":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the approval step"},"approvalsRequired":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The number of approvers required to approve this step before the approval moves to the next step"},"completedAt":{"description":"The date and time when the step was completed","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/ApprovalStepApprover"},"description":"An unordered list of users who can approve this step"}},"required":["id","approvalsRequired","approvers"],"additionalProperties":false},"Approval":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the approval"},"approvalDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the approval definition associated with this approval"},"entityId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the approval entity, such as the id of the offer version"},"entityType":{"type":"string","enum":["Job","Offer","Opening"],"description":"The type of entity associated with this approval"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the approval was created"},"submittedAt":{"description":"The date and time when the approval was submitted to approvers","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"completedAt":{"description":"The date and time when the approval was completed","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"steps":{"type":"array","items":{"$ref":"#/components/schemas/ApprovalStep"},"description":"The approval steps for this approval"}},"required":["id","approvalDefinitionId","entityId","entityType","createdAt","steps"],"additionalProperties":false},"ApprovalListRequest":{"type":"object","properties":{"entityType":{"description":"Filter approvals by the type of entity they are associated with","anyOf":[{"type":"string","enum":["offer","job","opening"]},{"type":"null"}]},"entityId":{"description":"Filter approvals to only those associated with this specific entity ID","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of approvals to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only approvals updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"ApprovalListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","approvalDefinitionId":"8af2ed38-6fd1-476b-9e95-3b57f6a0ee8f","entityId":"32665f7b-8d4c-4c58-9f28-62c5a4d20d57","entityType":"Offer","createdAt":"2024-01-15T10:30:00.000Z","submittedAt":"2024-01-15T10:35:00.000Z","completedAt":null,"steps":[{"id":"181c9a75-1646-4232-b312-e9a95b82af41","approvalsRequired":1,"completedAt":null,"approvers":[{"id":"f3268949-c6f2-4fb8-b85b-69806729fbb8","userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","decision":"pending","decidedAt":null,"requestedAt":"2024-01-15T10:35:00.000Z"}]}]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"ApprovalStepDefinitionApproverUser":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of a user who is an approver for this step.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"type":{"type":"string","const":"user","description":"The type of approver."}},"required":["userId","type"],"additionalProperties":false},"ApprovalStepDefinition":{"type":"object","properties":{"approvalsRequired":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The number of approvers required to approve this step, before the approval moves on to the next step. The number of approvers must be non-negative and no more than the number of approvers in this step.","example":1},"approvers":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ApprovalStepDefinitionApproverUser"},"description":"An unordered list of who can approve this step."}},"required":["approvalsRequired","approvers"],"additionalProperties":false},"ApprovalDefinition":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the approval definition."},"entityType":{"type":"string","const":"Offer","description":"The type of approval entity."},"entityId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the approval entity, such as the id of the offer version."},"approvalSteps":{"type":"array","items":{"$ref":"#/components/schemas/ApprovalStepDefinition"},"description":"An ordered list of approval steps that describes the number of required approvers at each step, as well as who is an approver at each step."}},"required":["id","entityType","entityId","approvalSteps"],"additionalProperties":false},"ApprovalDefinitionUpdateRequest":{"type":"object","properties":{"entityType":{"type":"string","const":"offer","description":"The type of approval entity being updated."},"entityId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the approval entity being updated, such as the id of the offer version.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"approvalStepDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/ApprovalStepDefinition"},"description":"An ordered list of approval steps that describes the number of required approvers at each step, as well as who is an approver at each step."},"submitApprovalRequest":{"description":"Control whether an approval request created through this API should be immediately submitted. If false, then the approval will need to be manually submitted in the Ashby app. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["entityType","entityId","approvalStepDefinitions"],"additionalProperties":false},"ApprovalDefinitionUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ApprovalDefinition"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"a4664a1d-b140-4da8-9a65-6efb8723f223","entityType":"Offer","entityId":"e78fffa1-6431-436f-a21a-004891b47ac5","approvalSteps":[{"approvalsRequired":1,"approvers":[{"type":"user","userId":"aa256a6b-2d2a-4a42-aed5-a94321a4e180"}]}]}}},"ApprovalDefinitionUpdateSkipSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true}},"required":["success"],"additionalProperties":false,"example":{"success":true}},"ApprovalDefinitionUpdateResponse":{"anyOf":[{"$ref":"#/components/schemas/ApprovalDefinitionUpdateSuccessResponse"},{"$ref":"#/components/schemas/ApprovalDefinitionUpdateSkipSuccessResponse"}],"example":{"success":true,"results":{"id":"a4664a1d-b140-4da8-9a65-6efb8723f223","entityType":"Offer","entityId":"e78fffa1-6431-436f-a21a-004891b47ac5","approvalSteps":[{"approvalsRequired":1,"approvers":[{"type":"user","userId":"aa256a6b-2d2a-4a42-aed5-a94321a4e180"}]}]}}},"ArchiveReason":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the archive reason","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","description":"The display text for the archive reason","example":"Too inexperienced"},"reasonType":{"type":"string","enum":["RejectedByCandidate","RejectedByOrg","Other"],"description":"The category of archive reason","example":"RejectedByOrg"},"isArchived":{"type":"boolean","description":"Whether the archive reason is archived"}},"required":["id","text","reasonType","isArchived"],"additionalProperties":false},"ArchiveReasonListRequest":{"type":"object","properties":{"includeArchived":{"description":"When true, includes archived archive reasons in the response. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},"ArchiveReasonListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ArchiveReason"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","text":"Too inexperienced","reasonType":"RejectedByOrg","isArchived":false}]}},"AssessmentDataValueType":{"type":"string","enum":["boolean_success","numeric_score","numeric_duration_milliseconds","numeric_duration_minutes","single_sign_on_url","string","numeric_timestamp_milliseconds","url"],"description":"The type of assessment data value"},"AssessmentDataValue":{"type":"object","properties":{"identifier":{"type":"string","description":"Uniquely identifies this field for this partner","example":"result-max"},"label":{"type":"string","description":"Label for the assessment data value to be displayed in the UI","example":"Max Score"},"description":{"description":"Description of the assessment data value, which may be displayed in the UI","example":"The maximum possible score for the assessment","anyOf":[{"type":"string"},{"type":"null"}]},"type":{"$ref":"#/components/schemas/AssessmentDataValueType"},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"}],"description":"The assessment data value, whose type depends on the type field","example":10},"isInternal":{"description":"Whether the field was generated internally by Ashby","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["identifier","label","type","value"],"additionalProperties":{}},"Assessment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the assessment"},"assessmentTypeId":{"type":"string","description":"An identifier that uniquely identifies the assessment type"},"assessmentName":{"type":"string","description":"The name of the assessment that was taken and displayed in the UI"},"assessmentId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An identifier that uniquely identifies the completed assessment"},"result":{"anyOf":[{"$ref":"#/components/schemas/AssessmentDataValue"},{"type":"null"}],"description":"The assessment result returned by the partner"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentDataValue"},"description":"An array of metadata associated with this completed assessment"},"applicationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The id of the application associated with this assessment"},"candidateId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The id of the candidate associated with this assessment"}},"required":["id","assessmentTypeId","assessmentName","assessmentId","result","metadata","applicationId","candidateId"],"additionalProperties":{}},"CompletedCandidateAssessment":{"type":"object","properties":{"assessmentTypeId":{"type":"string","description":"An identifier that uniquely identifies the assessment type","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"assessmentId":{"type":"string","description":"An identifier that uniquely identifies the completed assessment","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"assessmentName":{"type":"string","description":"The name of the assessment that was taken and displayed in the UI","example":"Node Assessment"},"result":{"description":"The assessment result returned by the partner","$ref":"#/components/schemas/AssessmentDataValue"},"metadata":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/AssessmentDataValue"},"description":"An array of metadata associated with this completed assessment"}},"required":["assessmentTypeId","assessmentId","assessmentName","result","metadata"],"additionalProperties":{}},"AssessmentAddCompletedToCandidateRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to whom to add the completed assessment","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"partnerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the partner adding the assessment","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"assessment":{"description":"The completed assessment to add","$ref":"#/components/schemas/CompletedCandidateAssessment"},"timestamp":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The timestamp in milliseconds since the unix epoch when the assessment was completed","example":1665680638489}},"required":["candidateId","partnerId","assessment","timestamp"],"additionalProperties":false},"AssessmentUpdateRequest":{"type":"object","properties":{"assessment_id":{"type":"string","description":"Identifier of the assessment being updated","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"timestamp":{"type":"number","description":"The timestamp in milliseconds since the unix epoch when the assessment update occurred","example":1665680638489},"assessment_status":{"description":"The current status of the assessment. Setting this with a value of \"Started\" will signal Ashby to store the timestamp the assessment started. Required when `cancelled_reason` is not set.","anyOf":[{"$ref":"#/components/schemas/AssessmentDataValue"},{"type":"null"}]},"assessment_profile_url":{"description":"The url back to the assessment/candidate on the partner's website. This value should always be of type url. Required when `assessment_result` is set.","anyOf":[{"$ref":"#/components/schemas/AssessmentDataValue"},{"type":"null"}]},"assessment_result":{"description":"The result of the assessment. Sending an update with this field will signal to Ashby that the assessment is complete.","anyOf":[{"$ref":"#/components/schemas/AssessmentDataValue"},{"type":"null"}]},"cancelled_reason":{"description":"The reason the assessment was cancelled. This field will signal to Ashby that the assessment is cancelled.","anyOf":[{"$ref":"#/components/schemas/AssessmentDataValue"},{"type":"null"}]},"metadata":{"description":"Any other metadata about the assessment (e.g. ETA until complete). All assessment data should have unique identifiers.","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/AssessmentDataValue"}},{"type":"null"}]}},"required":["assessment_id","timestamp"],"additionalProperties":{}},"AssessmentAddCompletedToCandidateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Assessment"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","assessmentTypeId":"node-assessment","assessmentName":"Node Assessment","assessmentId":"completed-node-assessment","result":{"identifier":"result","label":"Score","type":"numeric_score","value":10},"metadata":[{"identifier":"result-max","label":"Max Score","type":"numeric_score","value":10}],"applicationId":null,"candidateId":"f1e2d3c4-b5a6-4789-9012-3456789abcde"}}},"AssessmentUpdateResult":{"type":"object","properties":{"assessmentId":{"type":"string","description":"The identifier of the assessment that was updated"}},"required":["assessmentId"],"additionalProperties":false},"AssessmentUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/AssessmentUpdateResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"assessmentId":"completed-node-assessment"}}},"AuditLogActor":{"type":"object","properties":{"type":{"type":"string","description":"The kind of actor that performed the action: \"User\", \"Automation\", or \"Other\"."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the actor when one exists (typically a user id for User actors)."}},"required":["type","id"],"additionalProperties":false},"AuditLogTarget":{"type":"object","properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The target object type. See the Audit Log Vocabulary guide."},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the target object."}},"required":["type","id"],"additionalProperties":false},"AuditLogRequest":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the HTTP request that triggered the action, if any."},"ipAddress":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IP address of the client that made the request, if available."}},"required":["id","ipAddress"],"additionalProperties":false},"AuditLogFieldChange":{"type":"array","prefixItems":[{"description":"A string, number, boolean, opaque nested JSON value, an object reference of the form `{ \"ref\": \"<id>\", \"type\": \"<objectType>\" }`, or null when there was no value."},{"description":"A string, number, boolean, opaque nested JSON value, an object reference of the form `{ \"ref\": \"<id>\", \"type\": \"<objectType>\" }`, or null when there was no value."}],"description":"A `[before, after]` tuple describing one field's value change."},"AuditLogChangedFields":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/AuditLogFieldChange"}},{"type":"null"}],"description":"Per-field before/after change map for update actions; `null` for creates, deletes, or entries that pre-date the changeset."},"AuditLogParentAction":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The unique identifier of the parent action that caused this entry, if any."},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The kind of parent action (e.g. the bulk operation type)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A human-readable name for the parent action, if available."}},"required":["id","type","name"],"additionalProperties":false},"AuditLogEntry":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the audit log entry"},"timestamp":{"type":"string","description":"When the audited action occurred, as an ISO 8601 timestamp in UTC (e.g. 2026-06-02T15:04:05.123Z)."},"actor":{"description":"The actor that performed the audited action","$ref":"#/components/schemas/AuditLogActor"},"target":{"description":"The object the audited action was performed on","$ref":"#/components/schemas/AuditLogTarget"},"category":{"type":"string","description":"The action category with new categories appearing in responses over time; see the Audit Log Vocabulary guide."},"description":{"type":"string","description":"A human-readable description of the audited action."},"request":{"description":"The HTTP request that triggered the audited action. Present on all entries; fields are null for actions not triggered by an HTTP request (e.g. automations, system events).","$ref":"#/components/schemas/AuditLogRequest"},"parentAction":{"description":"The parent action that caused this audit entry, when the entry was produced as part of a larger operation (e.g. a bulk update). Fields are null when the entry is a standalone action.","$ref":"#/components/schemas/AuditLogParentAction"},"changedFields":{"$ref":"#/components/schemas/AuditLogChangedFields"}},"required":["id","timestamp","actor","target","category","description","request","parentAction","changedFields"],"additionalProperties":false},"AuditLogListRequest":{"type":"object","properties":{"cursor":{"description":"Opaque pagination cursor from a previous response's nextCursor. Reuse it only with the same startDate, endDate, and filter parameters as the request that produced it; changing the window or filters while keeping a cursor can return empty or incomplete pages.","example":"G8","type":"string"},"limit":{"description":"Maximum entries per page. Defaults to 100 when omitted. Maximum is 100.","example":25,"type":"integer","exclusiveMinimum":0,"maximum":100},"startDate":{"description":"ISO 8601 start of the date window (UTC). When omitted, defaults to 24 hours before endDate. When only startDate is supplied, endDate defaults to startDate plus 24 hours (not until now) — use both bounds for a custom span.","type":"string"},"endDate":{"description":"ISO 8601 end of the date window (UTC). When omitted with startDate, defaults to startDate plus 24 hours; when both are omitted, defaults to the current time.","type":"string"},"actorIds":{"description":"Restricts results to entries whose actor id is one of these values. An empty array is ignored, same as omitting this field. Max 100 items.","maxItems":100,"type":"array","items":{"type":"string"}},"targetIds":{"description":"Restricts results to entries whose target object id is one of these values. Combined with other filters using AND (all conditions must match). An empty array is ignored. Max 100 items.","maxItems":100,"type":"array","items":{"type":"string"}},"targetTypes":{"description":"Restricts results to entries whose target type is one of these values (e.g. \"job\", \"app_user\"). When both targetTypes and categories are supplied, matching uses OR (entries that match either filter). Combined with targetIds and actorIds using AND. An empty array is ignored. Max 100 items.","maxItems":100,"type":"array","items":{"type":"string"}},"categories":{"description":"Restricts results to entries in one of categories (e.g. \"JobStatusChanged\"). Max 100 items. See the Audit Log Vocabulary guide.","maxItems":100,"type":"array","items":{"type":"string"}}},"additionalProperties":false},"AuditLogListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogEntry"}},"nextCursor":{"description":"Opaque cursor for the next page when moreDataAvailable is true. Pass unchanged with the same date range and filters.","type":"string"},"moreDataAvailable":{"type":"boolean","description":"True when another page exists within the same date range and filter set."}},"required":["success","results","moreDataAvailable"],"additionalProperties":false,"examples":[{"success":true,"results":[{"id":"01JSJ8FE9M2WP3KQ7T6YB5R8AD","timestamp":"2026-06-02T15:06:10.000Z","actor":{"type":"User","id":"5f5b8d2e-1f3a-4c9b-8e2a-9d7c6b5a4f3e"},"target":{"type":"job","id":"7a1c3e9d-2b4f-4a8c-9e1d-6f5b4a3c2d1e"},"category":"JobTeamChanged","description":"Changed the team from Engineering to Customer Success.","request":{"id":"req_01JSJ8FE9M2WP3KQ7T6YB5R8AD","ipAddress":"198.51.100.42"},"parentAction":{"id":null,"type":null,"name":null},"changedFields":{"teamId":[{"ref":"b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e","type":"team"},{"ref":"c3d4e5f6-7a8b-4c9d-0e1f-2a3b4c5d6e7f","type":"team"}]}},{"id":"01JSJ8FG3K9XQ2VN5M7C4B6T1E","timestamp":"2026-06-02T15:09:42.500Z","actor":{"type":"User","id":"5f5b8d2e-1f3a-4c9b-8e2a-9d7c6b5a4f3e"},"target":{"type":"location","id":"9d0e1f2a-3b4c-4d5e-6f7a-8b9c0d1e2f3a"},"category":"LocationDetails","description":"Updated location name, set an external name, and made it remote.","request":{"id":"req_01JSJ8FG3K9XQ2VN5M7C4B6T1E","ipAddress":"203.0.113.7"},"parentAction":{"id":null,"type":null,"name":null},"changedFields":{"name":["SF Office","San Francisco HQ"],"externalName":[null,"San Francisco"],"isRemote":[false,true]}},{"id":"01JSJ8FH8N4YR3WP6Q9D5C7U2F","timestamp":"2026-06-02T15:12:00.000Z","actor":{"type":"User","id":"310b2025-a403-4daf-bb72-477106114dcb"},"target":{"type":"BulkDataImport","id":"cdbe44e2-aadc-4732-9496-7501f225e8f8"},"category":"BulkDataImportCompleted","description":"Completed bulk import of 10 candidates: 8 succeeded, 0 skipped, 2 failed","request":{"id":null,"ipAddress":null},"parentAction":{"id":"cdbe44e2-aadc-4732-9496-7501f225e8f8","type":"bulk_data_import","name":"candidate"},"changedFields":null}],"nextCursor":"eyJoIjoiMDFKU0o4Rkg4TjRZUjNXUDZROUQ1QzdVMkYifQ","moreDataAvailable":true},{"success":true,"results":[],"moreDataAvailable":false}]},"Brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the brand"},"name":{"type":"string","description":"The name of the brand"},"hostedJobsPageSlug":{"type":"string","description":"The slug used for the brand's hosted jobs page URL"}},"required":["id","name","hostedJobsPageSlug"],"additionalProperties":false},"BrandListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of brands to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":100},{"type":"null"}]}},"additionalProperties":false},"BrandListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Brand"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Acme","hostedJobsPageSlug":"acme"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CandidateTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The candidate tag's unique identifier"},"title":{"type":"string","description":"The tag's title"},"isArchived":{"type":"boolean","description":"Whether the tag has been archived"}},"required":["id","title","isArchived"],"additionalProperties":false},"CandidateTagCreateRequest":{"type":"object","properties":{"title":{"type":"string","description":"The tag's title. If a tag already exists with that title, the existing tag will be returned.","example":"Strong candidate"}},"required":["title"],"additionalProperties":false},"CandidateTagArchiveRequest":{"type":"object","properties":{"tagId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The candidate tag's unique id","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["tagId"],"additionalProperties":false},"CandidateTagListRequest":{"type":"object","properties":{"includeArchived":{"description":"Whether archived candidate tags should be included in the response","anyOf":[{"type":"boolean"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of candidate tags to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only candidate tags updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"CandidateTagCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/CandidateTag"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Strong candidate","isArchived":false}}},"CandidateTagArchiveSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/CandidateTag"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Strong candidate","isArchived":true}}},"CandidateTagListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/CandidateTag"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Strong candidate","isArchived":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"ProjectCustomField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field"},"isPrivate":{"type":"boolean","description":"Whether the custom field is private"},"title":{"type":"string","description":"The custom field's title"},"value":{"anyOf":[{"type":"boolean","description":"A boolean custom field value"},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"A date or date-time custom field value"},{"type":"string","description":"A text or select custom field value"},{"type":"array","items":{"type":"string"},"description":"A multi-select custom field value"},{"type":"number","description":"A number custom field value"},{"type":"object","properties":{"type":{"type":"string","const":"number-range","description":"The custom field range type"},"minValue":{"type":"number","description":"The minimum value for the range"},"maxValue":{"type":"number","description":"The maximum value for the range"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","const":"compensation-range","description":"The custom field range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}}],"description":"The custom field value"},"valueLabel":{"description":"The label of the custom field value, if the value is not already human-readable","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"null"}]}}]},{"type":"null"}]}},"required":["id","isPrivate","title","value"],"additionalProperties":false},"Project":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the project"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the project was created"},"title":{"type":"string","description":"The project's title"},"isArchived":{"type":"boolean","description":"Whether the project is archived"},"authorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user who created the project"},"description":{"description":"The project's description","anyOf":[{"type":"string"},{"type":"null"}]},"confidential":{"type":"boolean","description":"Whether the project is confidential"},"customFieldEntries":{"description":"All custom field values associated with the project","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ProjectCustomField"}},{"type":"null"}]}},"required":["id","createdAt","title","isArchived","authorId","confidential"],"additionalProperties":false},"ProjectSearchRequest":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"The project's title"}},"required":["title"],"additionalProperties":false},"ProjectSearchSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","title":"My Project","isArchived":false,"authorId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","description":"A project for sourcing candidates","confidential":false,"customFieldEntries":[]}]}},"ProjectInfoRequest":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the project","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["projectId"],"additionalProperties":false},"ProjectInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Project"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","title":"My Project","isArchived":false,"authorId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","description":"A project for sourcing candidates","confidential":false,"customFieldEntries":[]}}},"ProjectListRequest":{"type":"object","properties":{"createdAfter":{"description":"The API will return data after this date, which is the time since the unix epoch in milliseconds","example":1659979196538,"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"cursor":{"description":"Opaque cursor indicating which page of results to fetch","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"ProjectListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","title":"My Project","isArchived":false,"authorId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","description":"A project for sourcing candidates","confidential":false,"customFieldEntries":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"SourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source type's unique identifier"},"title":{"type":"string","description":"The title of the source type","example":"Inbound"},"isArchived":{"type":"boolean","description":"Whether the source type has been archived"}},"required":["id","title","isArchived"],"additionalProperties":false},"Source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The source's unique identifier"},"title":{"type":"string","description":"The title of the source","example":"Applied"},"isArchived":{"type":"boolean","description":"Whether the source has been archived"},"sourceType":{"description":"The source type associated with this source","$ref":"#/components/schemas/SourceType"}},"required":["id","title","isArchived","sourceType"],"additionalProperties":false},"SourceListRequest":{"type":"object","properties":{"includeArchived":{"description":"Whether archived sources should be included in the response","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},"SourceListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Source"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7","title":"Applied","isArchived":false,"sourceType":{"id":"9fbf7e23-bce5-4eb2-a4cb-3a05ec02db83","title":"Inbound","isArchived":false}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CandidateListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of candidates to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only candidates updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"description":"Unix timestamp (milliseconds). When provided, only candidates created at or after this time are returned. Must not be later than createdBefore or in the future.","anyOf":[{"type":"number"},{"type":"null"}]},"createdBefore":{"description":"Unix timestamp (milliseconds). When provided, only candidates created at or before this time are returned. Must not be in the future.","anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"ContactInfo":{"type":"object","properties":{"value":{"type":"string","description":"The email address or phone number of the candidate"},"type":{"type":"string","enum":["Personal","Work","Other"],"description":"The type of the contact info"},"isPrimary":{"type":"boolean","description":"Whether the contact info is the primary email or phone number"}},"required":["value","type","isPrimary"],"additionalProperties":false},"SocialLink":{"type":"object","properties":{"type":{"type":"string","enum":["LinkedIn","GitHub","Twitter","Medium","StackOverflow","Website","YouTube","CodePen"],"description":"The type of social link"},"url":{"type":"string","description":"The URL of the social profile"}},"required":["type","url"],"additionalProperties":false},"FileHandle":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the file","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"name":{"type":"string","description":"The file name"},"handle":{"type":"string","description":"The file handle, which can be used with the file.info endpoint"}},"required":["id","name","handle"],"additionalProperties":false},"CandidateCustomField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"isPrivate":{"type":"boolean","description":"Whether the custom field is private"},"title":{"type":"string","description":"The title of the custom field"},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"null"}],"description":"The custom field value"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"null"}]}}]},{"type":"null"}]}},"required":["id","isPrivate","title","value"],"additionalProperties":false},"CandidateLocationComponent":{"type":"object","properties":{"type":{"type":"string","description":"The type of the location component"},"name":{"type":"string","description":"The name of the location component"}},"required":["type","name"],"additionalProperties":false},"CandidateLocation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the location","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"locationSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A human-readable summary of the location"},"locationComponents":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/CandidateLocationComponent"}},{"type":"null"}],"description":"The individual components of the location"}},"required":["id","locationSummary","locationComponents"],"additionalProperties":false},"Candidate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the candidate"},"createdAt":{"type":"string","description":"The timestamp when the candidate was created"},"updatedAt":{"type":"string","description":"The timestamp when the candidate was last updated"},"name":{"type":"string","description":"The candidate's name"},"primaryEmailAddress":{"anyOf":[{"$ref":"#/components/schemas/ContactInfo"},{"type":"null"}],"description":"The candidate's primary email address"},"emailAddresses":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfo"},"description":"The candidate's email addresses"},"primaryPhoneNumber":{"anyOf":[{"$ref":"#/components/schemas/ContactInfo"},{"type":"null"}],"description":"The candidate's primary phone number"},"phoneNumbers":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfo"},"description":"The candidate's phone numbers"},"socialLinks":{"type":"array","items":{"$ref":"#/components/schemas/SocialLink"},"description":"The candidate's social links"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/CandidateTag"},"description":"The candidate's tags"},"position":{"description":"The candidate's current position","type":"string"},"company":{"description":"The candidate's current company","type":"string"},"school":{"description":"The candidate's school","type":"string"},"applicationIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The unique identifiers of the candidate's applications"},"resumeFileHandle":{"anyOf":[{"$ref":"#/components/schemas/FileHandle"},{"type":"null"}],"description":"The file handle for the candidate's resume"},"fileHandles":{"type":"array","items":{"$ref":"#/components/schemas/FileHandle"},"description":"The file handles associated with the candidate"},"customFields":{"description":"The custom field values associated with the candidate","type":"array","items":{"$ref":"#/components/schemas/CandidateCustomField"}},"profileUrl":{"type":"string","description":"The URL of the candidate's profile in Ashby"},"source":{"description":"The source that created this candidate","anyOf":[{"$ref":"#/components/schemas/Source"},{"type":"null"}]},"creditedToUser":{"description":"The user who receives credit for this candidate","anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"timezone":{"description":"The candidate's timezone","anyOf":[{"type":"string"},{"type":"null"}]},"location":{"description":"The primary location of the candidate","anyOf":[{"$ref":"#/components/schemas/CandidateLocation"},{"type":"null"}]},"fraudStatus":{"description":"The fraud status of the candidate","anyOf":[{"type":"string","enum":["Fraudulent","NotFraudulent","Unsure","Unreviewed","PassedFraudCheck"]},{"type":"null"}]}},"required":["id","createdAt","updatedAt","name","primaryEmailAddress","emailAddresses","primaryPhoneNumber","phoneNumbers","socialLinks","tags","applicationIds","resumeFileHandle","fileHandles","profileUrl"],"additionalProperties":false},"CandidateRemoveProjectRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the project","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["candidateId","projectId"],"additionalProperties":false},"CandidateRemoveProjectSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Candidate"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CandidateExternalMapping":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier of the external mapping"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the candidate"},"applicationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The ID of the application. Null for systems that do not support per-application pushes (e.g. ADP, BambooHR); populated for systems that do (e.g. Workday, Lattice, Oracle HCM)."},"externalId":{"type":"string","description":"The external ID in the HRIS system"},"externalSystem":{"type":"string","enum":["ADP","BambooHR","bob","Charthop","Dayforce","Enboarder","Gusto","Lattice","Namely","OracleHCM","Paychex","Paylocity","Personio","Remote","Rippling","SAP","SelfServe","UKG","Workday"],"description":"The HRIS system the candidate was pushed to"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"ISO 8601 timestamp of when the mapping was created"}},"required":["id","candidateId","applicationId","externalId","externalSystem","createdAt"],"additionalProperties":false},"CandidatePushToHrisRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the application whose candidate should be pushed to the HRIS.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"externalSystem":{"type":"string","enum":["ADP","BambooHR","bob","Charthop","Dayforce","Enboarder","Gusto","Lattice","Namely","OracleHCM","Paychex","Paylocity","Personio","Remote","Rippling","SAP","SelfServe","UKG","Workday"],"description":"The HRIS system to push the candidate to. Note: HiBob uses the value \"bob\"."},"integrationPartnerId":{"description":"The ID of the integration partner. Required for SelfServe integrations.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["applicationId","externalSystem"],"additionalProperties":false},"CandidatePushToHrisSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/CandidateExternalMapping"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"f1a2b3c4-d5e6-7890-abcd-ef1234567890","candidateId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applicationId":"f9e52a51-a075-4116-a7b8-484deba69004","externalId":"WD-12345","externalSystem":"Workday","createdAt":"2024-01-15T10:30:00.000Z"}}},"Author":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"description":"The user's email address","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","firstName","lastName"],"additionalProperties":false},"Note":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the note"},"createdAt":{"type":"string","description":"The timestamp when the note was created"},"isPrivate":{"type":"boolean","description":"Whether the note is private"},"content":{"description":"The note's content as plain text","anyOf":[{"type":"string"},{"type":"null"}]},"author":{"description":"The user who created the note","$ref":"#/components/schemas/Author"}},"required":["id","createdAt","isPrivate","author"],"additionalProperties":false},"EmailMessage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the email in Ashby"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The candidate this email is attached to"},"emailProviderEmailId":{"type":"string","description":"The unique identifier for this message in the partner system"},"subject":{"type":"string","description":"The email subject line"},"from":{"type":"string","description":"The sender email address"},"to":{"type":"string","description":"The recipient email address"},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The body of the email. Can be HTML or plain text"},"sentAt":{"type":"string","description":"When the email was sent"},"cc":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CC recipients"},"messageUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"URL to view the message in the partner application"},"messageIdHeader":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"RFC 5322 Message-ID header value"},"threadId":{"type":"string","description":"Thread identifier grouping this message with others"},"isPrivate":{"type":"boolean","description":"Whether the email is marked as private"},"userIsSender":{"type":"boolean","description":"Whether the associated user is the sender (true) or recipient (false)"}},"required":["id","candidateId","emailProviderEmailId","subject","from","to","body","sentAt","cc","messageUrl","messageIdHeader","threadId","isPrivate","userIsSender"],"additionalProperties":false},"FraudSignal":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier of this fraud signal instance"},"category":{"type":"string","description":"The category of the fraud signal. Possible values include \"Social\", \"Automation\", \"Geographic\", and \"Spoofing\". Note: this field is unstable and may change over time."},"name":{"type":"string","description":"A human-readable name for this fraud signal. Note: this field is unstable and may change over time."},"description":{"type":"string","description":"A description of what this fraud signal means. Note: this field is unstable and may change over time."},"value":{"description":"An optional value associated with this signal, providing additional context (e.g., location information, account counts). Only present when a value exists for the signal. Note: this field is unstable and may change over time.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","category","name","description"],"additionalProperties":false},"FraudCheck":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier of this fraud check"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate this fraud check belongs to"},"applicationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The id of the application this fraud check is associated with, if any"},"createdAt":{"type":"string","description":"When this fraud check was performed"},"fraudSignals":{"type":"array","items":{"$ref":"#/components/schemas/FraudSignal"},"description":"The fraud signals detected during this fraud check"}},"required":["id","candidateId","applicationId","createdAt","fraudSignals"],"additionalProperties":false},"ClientInfo":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of this client information record"},"ipAddress":{"description":"The IP address (v4 or v6) that the client used to interact with the system","anyOf":[{"type":"string"},{"type":"null"}]},"userAgent":{"description":"The user agent that was received from the client when it interacted with the system","anyOf":[{"type":"string"},{"type":"null"}]},"relatedEntityType":{"type":"string","enum":["application","blocked_application_submission","meeting_availability_request"],"description":"The type of the entity that the client interacted with"},"relatedEntityId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the entity that was related to the client interaction"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the candidate that interacted with the system"},"createdAt":{"description":"When this client info record was created","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","relatedEntityType","relatedEntityId","candidateId"],"additionalProperties":false},"CandidateAddEmailMessageRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The candidate to attach this email to","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"emailProviderEmailId":{"type":"string","description":"Unique identifier for this message in the partner system. Must be unique per API key."},"subject":{"type":"string","description":"The email subject line"},"from":{"type":"string","description":"The sender email address"},"to":{"type":"string","description":"The recipient email address"},"body":{"type":"string","description":"The html body of the email"},"userId":{"description":"The Ashby user ID to associate with this email. Defaults to the API key user.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"sentAt":{"description":"When the email was sent. Defaults to the current time.","example":"2022-07-21T17:32:28Z","anyOf":[{"type":"string"},{"type":"null"}]},"cc":{"description":"CC recipients","anyOf":[{"type":"string"},{"type":"null"}]},"messageUrl":{"description":"URL to view the message in the partner application","example":"https://example.com/messages/1234567890","anyOf":[{"type":"string"},{"type":"null"}]},"messageIdHeader":{"description":"RFC 5322 message identifier","example":"<CADkMx=Abc123@examplemail.com>","anyOf":[{"type":"string"},{"type":"null"}]},"threadId":{"description":"Thread identifier to group this message with others. Defaults to emailProviderEmailId.","anyOf":[{"type":"string"},{"type":"null"}]},"isPrivate":{"description":"Whether the email should be marked as private. Private emails require \"Allow access to non-offer private fields?\" API key permission to create and view. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["candidateId","emailProviderEmailId","subject","from","to","body"],"additionalProperties":false},"CandidateAddProjectRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the project","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["candidateId","projectId"],"additionalProperties":false},"CandidateAddTagRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the candidate to add the tag to","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"tagId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the tag to add to the candidate","example":"38430ede-5bd2-41fc-b474-87591cb98cbc"}},"required":["candidateId","tagId"],"additionalProperties":false},"CandidateAnonymizeRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to anonymize","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["candidateId"],"additionalProperties":false},"CandidateCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The first and last name of the candidate to be created","example":"Adam Hart"},"email":{"description":"Primary, personal email of the candidate to be created","example":"test@ashbyhq.com","anyOf":[{"type":"string"},{"type":"null"}]},"phoneNumber":{"description":"Primary, personal phone number of the candidate to be created","example":"555-555-5555","anyOf":[{"type":"string"},{"type":"null"}]},"linkedInUrl":{"description":"Url to the candidate's LinkedIn profile. Must be a valid Url.","example":"https://linkedin.com/in/user","anyOf":[{"type":"string"},{"type":"null"}]},"githubUrl":{"description":"Url to the candidate's Github profile. Must be a valid Url.","example":"https://github.com/user","anyOf":[{"type":"string"},{"type":"null"}]},"website":{"description":"Url of the candidate's website. Must be a valid Url.","example":"https://twitter.com/user","anyOf":[{"type":"string"},{"type":"null"}]},"alternateEmailAddresses":{"description":"Array of alternate email addresses to add to the candidate's profile","example":["test.email@ashbyhq.com"],"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"sourceId":{"description":"The source to set on the candidate being created","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"creditedToUserId":{"description":"The id of the user the candidate will be credited to","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"location":{"description":"The location of the candidate","anyOf":[{"type":"object","properties":{"city":{"description":"The city of the candidate's location","example":"San Francisco","anyOf":[{"type":"string"},{"type":"null"}]},"region":{"description":"The region (state, province, etc.) of the candidate's location","example":"California","anyOf":[{"type":"string"},{"type":"null"}]},"country":{"description":"The country of the candidate's location","example":"United States","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"createdAt":{"description":"An ISO date string to set the candidate's `createdAt` timestamp. When this value isn't provided, the `createdAt` timestamp defaults to the time the call was made.","example":"2022-08-12T20:29:56.964Z","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name"],"additionalProperties":false},"CandidateCreateNoteRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"note":{"anyOf":[{"type":"string"},{"type":"object","properties":{"type":{"type":"string","enum":["text/plain","text/html"],"description":"The content type of the note"},"value":{"type":"string","description":"The note's content"}},"required":["type","value"],"additionalProperties":false}],"description":"The note to add to the candidate. Either a plain string, or an object `{ type, value }` where `type` is `text/plain` or `text/html`.","example":"Strong candidate, very interested in the company"},"sendNotifications":{"description":"Whether or not users who are subscribed to the candidate should be notified that the note was posted. Default is false.","anyOf":[{"type":"boolean"},{"type":"null"}]},"isPrivate":{"description":"Whether the note should be marked as private. Private notes require \"Allow access to non-offer private fields?\" API key permission to create and view. Default is false.","anyOf":[{"type":"boolean"},{"type":"null"}]},"createdAt":{"description":"An ISO date string to set the note's `createdAt` timestamp","example":"2022-08-12T20:29:56.964Z","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["candidateId","note"],"additionalProperties":false},"CandidateInfoRequest":{"type":"object","properties":{"id":{"description":"The id of the candidate to fetch","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"externalMappingId":{"description":"An id assigned to a candidate outside of Ashby. Used to associate Ashby candidates with their profiles in external systems (BambooHR, Rippling, Gusto, etc.)","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"CandidateListClientInfoRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to fetch client info for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"cursor":{"description":"Opaque cursor indicating which page of results to fetch","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["candidateId"],"additionalProperties":false},"CandidateListFraudChecksRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to fetch fraud checks for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"cursor":{"description":"Opaque cursor indicating which page of results to fetch","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["candidateId"],"additionalProperties":false},"CandidateListNotesRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to fetch notes for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"cursor":{"description":"Opaque cursor indicating which page of results to fetch","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["candidateId"],"additionalProperties":false},"CandidateListProjectsRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to fetch projects for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"cursor":{"description":"Opaque cursor indicating which page of results to fetch","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["candidateId"],"additionalProperties":false},"CandidateRemoveTagRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to remove the tag from","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"tagId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the tag to remove from the candidate","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["candidateId","tagId"],"additionalProperties":false},"CandidateSearchRequest":{"type":"object","properties":{"email":{"description":"The candidate's email","anyOf":[{"type":"string"},{"type":"null"}]},"name":{"description":"The candidate's name","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"CandidateSetFraudStatusRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to set the fraud status for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"fraudStatus":{"type":"string","enum":["Fraudulent","NotFraudulent","Unsure"],"description":"The fraud status to set for the candidate","example":"Fraudulent"}},"required":["candidateId","fraudStatus"],"additionalProperties":false},"CandidateUpdateRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the candidate to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"name":{"description":"The first and last name of the candidate to update","example":"Adam Hart","anyOf":[{"type":"string"},{"type":"null"}]},"email":{"description":"Primary, personal email of the candidate to update","example":"test@ashbyhq.com","anyOf":[{"type":"string"},{"type":"null"}]},"phoneNumber":{"description":"Primary, personal phone number of the candidate to update","example":"555-555-5555","anyOf":[{"type":"string"},{"type":"null"}]},"linkedInUrl":{"description":"Url to the candidate's LinkedIn profile. Must be a valid Url.","example":"https://linkedin.com/in/user","anyOf":[{"type":"string"},{"type":"null"}]},"githubUrl":{"description":"Url to the candidate's Github profile. Must be a valid Url.","example":"https://github.com/user","anyOf":[{"type":"string"},{"type":"null"}]},"websiteUrl":{"description":"Url of the candidate's website. Must be a valid Url.","example":"https://twitter.com/user","anyOf":[{"type":"string"},{"type":"null"}]},"alternateEmail":{"description":"An alternate email address to add to the candidate's profile","example":"test.email@ashbyhq.com","anyOf":[{"type":"string"},{"type":"null"}]},"socialLinks":{"description":"An array of social links to set on the candidate. This value replaces existing socialLinks that have been set on the candidate. If this value is submitted along with linkedInUrl, gitHubUrl or websiteUrl fields, those values will be ignored.","anyOf":[{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The social link type","example":"LinkedIn"},"url":{"type":"string","description":"The URL of the social profile","example":"https://linkedin.com/in/user"}},"required":["type","url"],"additionalProperties":false}},{"type":"null"}]},"sourceId":{"description":"The id of source for this candidate","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"creditedToUserId":{"description":"The id of the user the candidate will be credited to","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"location":{"description":"The location of the candidate","anyOf":[{"type":"object","properties":{"city":{"description":"The city of the candidate's location","example":"San Francisco","anyOf":[{"type":"string"},{"type":"null"}]},"region":{"description":"The region (state, province, etc.) of the candidate's location","example":"California","anyOf":[{"type":"string"},{"type":"null"}]},"country":{"description":"The country of the candidate's location","example":"United States","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"createdAt":{"description":"An ISO date string to set the candidate's `createdAt` timestamp","example":"2022-08-12T20:29:56.964Z","anyOf":[{"type":"string"},{"type":"null"}]},"sendNotifications":{"description":"Whether or not users who are subscribed to the candidate should be notified that the candidate was updated. Default is true.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["candidateId"],"additionalProperties":false},"CandidateUploadResumeRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"resumeHandle":{"description":"A handle returned by `file.createFileUploadHandle` after uploading a resume file to the presigned URL.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["candidateId"],"additionalProperties":{}},"CandidateUploadFileRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"fileHandle":{"description":"A handle returned by `file.createFileUploadHandle` after uploading a file to the presigned URL.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["candidateId"],"additionalProperties":{}},"CandidateAddEmailMessageSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/EmailMessage"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"9d8eb6b1-9b6f-4c9d-9c1e-5a07f9b4f9c0","candidateId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","emailProviderEmailId":"msg-12345","subject":"Re: Application","from":"recruiter@example.com","to":"adam.hart@example.com","body":"<p>Thanks for applying!</p>","sentAt":"2024-01-15T10:30:00.000Z","cc":null,"messageUrl":null,"messageIdHeader":null,"threadId":"msg-12345","isPrivate":false,"userIsSender":true}}},"CandidateAddProjectSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateAddTagSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateAnonymizeSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateCreateNoteSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Note"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"5fa61e0b-3c4d-4e5f-9a0b-1c2d3e4f5a6b","createdAt":"2024-01-15T10:30:00.000Z","isPrivate":false,"content":"Strong candidate, very interested in the company","author":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","firstName":"George","lastName":"Bluth","email":"george@bluth.example"}}}},"CandidateInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateListClientInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ClientInfo"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"7d31034c-790b-4265-bf63-d65396d59d0b","ipAddress":"86.234.23.243","userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36","relatedEntityType":"application","relatedEntityId":"57133f77-9362-4397-b395-03bda1f72303","candidateId":"9d22854f-c929-4b86-9f42-cb71cc0e4fc7","createdAt":"2024-01-15T10:30:00.000Z"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CandidateListFraudChecksSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/FraudCheck"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"f5b1e9a2-3c4d-4e5f-9a0b-1c2d3e4f5a6b","candidateId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applicationId":null,"createdAt":"2025-01-15T10:30:00.000Z","fraudSignals":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CandidateListNotesSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Note"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"5fa61e0b-3c4d-4e5f-9a0b-1c2d3e4f5a6b","createdAt":"2024-01-15T10:30:00.000Z","isPrivate":false,"content":"Strong candidate, very interested in the company","author":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","firstName":"George","lastName":"Bluth","email":"george@bluth.example"}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CandidateListProjectsSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"bcffca12-5b09-4a76-acf2-00a8e267b222","createdAt":"2024-01-15T10:30:00.000Z","title":"Senior Engineers","isArchived":false,"authorId":"7211e226-7802-41fd-8d55-2720fe9d534f","description":"Project for sourcing senior engineers","confidential":false,"customFieldEntries":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CandidateRemoveTagSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateSearchSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Candidate"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}]}},"CandidateSetFraudStatusSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateUploadResumeSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CandidateUploadFileSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Candidate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-16T10:30:00.000Z","name":"Adam Hart","primaryEmailAddress":{"value":"adam.hart@example.com","type":"Personal","isPrimary":true},"emailAddresses":[{"value":"adam.hart@example.com","type":"Personal","isPrimary":true}],"primaryPhoneNumber":null,"phoneNumbers":[],"socialLinks":[],"tags":[],"applicationIds":["f9e52a51-a075-4116-a7b8-484deba69004"],"resumeFileHandle":null,"fileHandles":[],"profileUrl":"https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","source":null,"creditedToUser":null,"timezone":null,"fraudStatus":null}}},"CloseReason":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The reason's unique id"},"reasonText":{"type":"string","description":"The text of the reason","example":"Position Filled"},"isArchived":{"type":"boolean","description":"Whether the close reason has been archived"}},"required":["id","reasonText","isArchived"],"additionalProperties":false},"CloseReasonListRequest":{"type":"object","properties":{"includeArchived":{"description":"Whether to include archived close reasons in the response.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},"CloseReasonListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/CloseReason"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"8d1f3b6c-6f31-4d29-9c1f-1f4c5b4d8f4a","reasonText":"Position Filled","isArchived":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CommunicationTemplate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the communication template","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the communication template was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the communication template was last updated"},"title":{"type":"string","description":"The display title of the communication template","example":"Rejection + Consideration for Future Positions"},"intendedTypes":{"type":"array","items":{"type":"string","enum":["email","inMail","linkedInConnection","telephonySms"]},"description":"The communication channels this template is intended for","example":["email","inMail"]}},"required":["id","createdAt","updatedAt","title","intendedTypes"],"additionalProperties":false},"CommunicationTemplateListRequest":{"type":"object","properties":{},"additionalProperties":false},"CommunicationTemplateListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/CommunicationTemplate"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2024-01-15T10:30:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","title":"Rejection + Consideration for Future Positions","intendedTypes":["email","inMail"]}]}},"CustomFieldSelectableValue":{"type":"object","properties":{"label":{"type":"string","description":"The display label for the selectable value"},"value":{"type":"string","description":"The API value for the selectable value"},"isArchived":{"type":"boolean","description":"Whether the selectable value is archived"}},"required":["label","value","isArchived"],"additionalProperties":false},"CustomFieldDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The custom field's unique identifier"},"title":{"type":"string","description":"The custom field's title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A description of the custom field"},"objectType":{"type":"string","description":"The type of object the field is associated with"},"isArchived":{"type":"boolean","description":"Whether the custom field is archived"},"isPrivate":{"type":"boolean","description":"Whether the custom field is private"},"fieldType":{"type":"string","description":"The custom field's field type"},"isRequired":{"type":"boolean","description":"Whether the custom field is required"},"selectableValues":{"description":"Selectable values for ValueSelect and MultiValueSelect custom fields","type":"array","items":{"$ref":"#/components/schemas/CustomFieldSelectableValue"}}},"required":["id","title","description","objectType","isArchived","isPrivate","fieldType","isRequired"],"additionalProperties":false},"CustomFieldCreateRequest":{"type":"object","properties":{"fieldType":{"type":"string","enum":["Boolean","CompensationRange","Currency","Date","LongText","MultiValueSelect","Number","NumberRange","String","ValueSelect","Url","UUID"],"description":"The type of field being created. This value is case-sensitive."},"objectType":{"description":"The type of object the field can be associated with.","type":"string","enum":["Application","Candidate","Job","Employee","Talent_Project","Opening","Offer","Opening_Version","Offer_Version"]},"title":{"type":"string","description":"The name of the field"},"description":{"description":"A description for the field","anyOf":[{"type":"string"},{"type":"null"}]},"selectableValues":{"description":"Required when the field type is ValueSelect or MultiValueSelect. An array of selectable values for the field.","anyOf":[{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"description":"The display label for the selectable value"},"value":{"type":"string","minLength":1,"description":"The API value for the selectable value"}},"required":["label","value"],"additionalProperties":false}},{"type":"null"}]},"isDateOnlyField":{"description":"Only applies to fields with a fieldType of Date. Whether or not the field includes content other than a date.","anyOf":[{"type":"boolean"},{"type":"null"}]},"isExposableToCandidate":{"description":"Determines whether the field can be exposed to a candidate in certain contexts. In order for a custom field to be available in an email template this value must be true.","anyOf":[{"type":"boolean"},{"type":"null"}]},"isPrivate":{"description":"Whether the custom field should be private.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["fieldType","objectType","title"],"additionalProperties":false},"CustomFieldCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/CustomFieldDefinition"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Preferred Team","description":"A description of the custom field","objectType":"Application","isArchived":false,"isPrivate":false,"fieldType":"String","isRequired":false}}},"CustomFieldOnObject":{"type":"object","properties":{"id":{"type":"string","description":"The custom field definition's unique identifier"},"title":{"type":"string","description":"The custom field's title"},"isPrivate":{"description":"Whether the custom field is private","type":"boolean"},"valueLabel":{"description":"The label of the custom field value. Only present for ValueSelect and MultiValueSelect fields.","anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"object","properties":{"country":{"description":"The country of the location","type":"string"},"region":{"description":"The region of the location","type":"string"},"city":{"description":"The city of the location","type":"string"}},"additionalProperties":{}},{"type":"null"}],"description":"The current value of the custom field. The shape depends on the field's `fieldType` (boolean, string, number, ISO date, object, array, etc.). See the `customField.setValue` docs for per-type details."}},"required":["id","title","value"],"additionalProperties":false},"CustomFieldInfoRequest":{"type":"object","properties":{"customFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the custom field to fetch","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["customFieldId"],"additionalProperties":false},"CustomFieldInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/CustomFieldDefinition"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Preferred Team","description":"A description of the custom field","objectType":"Application","isArchived":false,"isPrivate":false,"fieldType":"String","isRequired":false}}},"CustomFieldListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only custom fields updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"integer","minimum":1,"maximum":100},{"type":"null"}]},"includeArchived":{"description":"If true, archived custom fields will be included in the response","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},"CustomFieldListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldDefinition"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Preferred Team","description":"A description of the custom field","objectType":"Application","isArchived":false,"isPrivate":false,"fieldType":"String","isRequired":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"CustomFieldSetValueRequest":{"type":"object","properties":{"objectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the object the field value is being set on.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"objectType":{"description":"The type of object the field is associated with.","type":"string","enum":["Application","Candidate","Job","Opening"]},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the Custom Field definition for the field","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"fieldValue":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"object","properties":{"country":{"description":"The country of the location","type":"string"},"region":{"description":"The region of the location","type":"string"},"city":{"description":"The city of the location","type":"string"}},"additionalProperties":{}},{"type":"null"}],"description":"The value to store in the field. The accepted type depends on the custom field's `fieldType` (boolean, string, number, ISO date, object, array, etc.). See the description above for the full per-type table.\n- Location field: An object with the following properties: `{ country: \"USA\", city: \"San Francisco\", region: \"California\" }`. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties."}},"required":["objectId","objectType","fieldId","fieldValue"],"additionalProperties":false},"CustomFieldSetValueSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/CustomFieldOnObject"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Preferred Team","isPrivate":false,"value":"Backend"}}},"CustomFieldSetValuesRequest":{"type":"object","properties":{"objectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the object the field values are being set on.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"objectType":{"description":"The type of object the fields are associated with.","type":"string","enum":["Application","Candidate","Job","Opening"]},"values":{"minItems":1,"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the Custom Field definition for the field","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"fieldValue":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"object","properties":{"country":{"description":"The country of the location","type":"string"},"region":{"description":"The region of the location","type":"string"},"city":{"description":"The city of the location","type":"string"}},"additionalProperties":{}},{"type":"null"}],"description":"The value to store in the field. The accepted type depends on the custom field's `fieldType`. See the description above for the full per-type table.\n- Location field: An object with the following properties: `{ country: \"USA\", city: \"San Francisco\", region: \"California\" }`. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties."}},"required":["fieldId","fieldValue"],"additionalProperties":false},"description":"Array of custom field updates to apply"}},"required":["objectId","objectType","values"],"additionalProperties":false},"CustomFieldSetValuesSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldOnObject"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Preferred Team","isPrivate":false,"value":"Backend"}]}},"CustomFieldUpdateSelectableValuesRequest":{"type":"object","properties":{"customFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the custom field to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"selectableValues":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"description":"The display label for this selectable value"},"value":{"type":"string","minLength":1,"description":"The internal value for this selectable value (used as the unique identifier)"},"isArchived":{"description":"Whether this value should be archived. Defaults to false if not provided.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["label","value"],"additionalProperties":false},"description":"An array of selectable values to merge with the existing values. Only `label`, `value`, and optionally `isArchived` should be provided."}},"required":["customFieldId","selectableValues"],"additionalProperties":false},"CustomFieldUpdateSelectableValuesSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/CustomFieldDefinition"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Preferred Team","description":"A description of the custom field","objectType":"Application","isArchived":false,"isPrivate":false,"fieldType":"String","isRequired":false}}},"Department":{"type":"object","properties":{"id":{"type":"string","description":"The department's unique identifier"},"name":{"type":"string","description":"The name of the department or team"},"externalName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An alternate candidate-facing name for this department that will be used on Ashby job boards"},"isArchived":{"type":"boolean","description":"Whether the department has been archived"},"parentId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id of the department's parent department"},"createdAt":{"type":"string","description":"The timestamp when the department was created"},"updatedAt":{"type":"string","description":"The timestamp when the department was last updated"},"extraData":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Key-value pairs for your own use and reference. Keys must be at most 100 characters, values at most 512 characters, and total size less than 1kb.","example":{"partner_external_object_id":"12345","partner_additional_data":"f763ba0e4"}}},"required":["id","name","externalName","isArchived","parentId","createdAt","updatedAt","extraData"],"additionalProperties":false},"DepartmentInfoRequest":{"type":"object","properties":{"departmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the department whose details will be fetched","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["departmentId"],"additionalProperties":false},"DepartmentListRequest":{"type":"object","properties":{"includeArchived":{"description":"Whether archived departments should be included in the response","anyOf":[{"type":"boolean"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of departments to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only departments updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"DepartmentCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the department or team","example":"Engineering Operations"},"externalName":{"description":"An alternate candidate-facing name for this department that will be used on Ashby job boards","example":"Engineering","anyOf":[{"type":"string"},{"type":"null"}]},"parentId":{"description":"The id of the department's parent department","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"extraData":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Key-value pairs for your own use and reference. Keys must be at most 100 characters, values at most 512 characters, and total size less than 1kb.","example":{"partner_external_object_id":"12345","partner_additional_data":"f763ba0e4"}}},"required":["name"],"additionalProperties":false},"DepartmentUpdateRequest":{"type":"object","properties":{"departmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The department's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"},"name":{"type":"string","description":"The name of the department or team","example":"Engineering Operations"},"externalName":{"description":"An alternate candidate-facing name for this department that will be used on Ashby job boards","example":"Engineering","anyOf":[{"type":"string"},{"type":"null"}]},"extraData":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Key-value pairs for your own use and reference. Keys must be at most 100 characters, values at most 512 characters, and total size less than 1kb.","example":{"partner_external_object_id":"12345","partner_additional_data":"f763ba0e4"}}},"required":["departmentId","name"],"additionalProperties":false},"DepartmentMoveRequest":{"type":"object","properties":{"departmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The department's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"},"parentId":{"description":"The department parent's ID. Pass null (or omit) to move to the top level.","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["departmentId"],"additionalProperties":false},"DepartmentArchiveRequest":{"type":"object","properties":{"departmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The department's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"}},"required":["departmentId"],"additionalProperties":false},"DepartmentRestoreRequest":{"type":"object","properties":{"departmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The department's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"}},"required":["departmentId"],"additionalProperties":false},"DepartmentInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Department"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"DepartmentListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Department"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"DepartmentCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Department"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"DepartmentUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Department"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"DepartmentMoveSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Department"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"DepartmentArchiveSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Department"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":true,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"DepartmentRestoreSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Department"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","name":"Engineering Operations","externalName":"Engineering","isArchived":false,"parentId":null,"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-01T00:00:00.000Z","extraData":null}}},"EmailSender":{"type":"object","properties":{"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The email address that can be used to send a sequence"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The display name used when sending from this address, if configured"},"type":{"type":"string","enum":["Primary","PersonalAlias","OrganizationAlias","NoReply"],"description":"How the address is made available to the acting identity"}},"required":["email","displayName","type"],"additionalProperties":false},"EmailSenderListRequest":{"type":"object","properties":{},"additionalProperties":false},"EmailSenderListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/EmailSender"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"email":"recruiting@example.com","displayName":"Example Recruiting","type":"OrganizationAlias"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"FeedbackFormDefinition":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the feedback form definition"},"organizationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the organization"},"title":{"type":"string","description":"The title of the feedback form definition"},"isArchived":{"type":"boolean","description":"Whether the feedback form definition is archived"},"isDefaultForm":{"type":"boolean","description":"Whether this is the organization's default feedback form definition"},"formDefinition":{"description":"The form schema for this feedback form","$ref":"#/components/schemas/FormDefinition"},"interviewId":{"description":"The interview this feedback form definition belongs to, if interview-specific","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","organizationId","title","isArchived","isDefaultForm","formDefinition"],"additionalProperties":false},"FeedbackFormDefinitionInfoRequest":{"type":"object","properties":{"feedbackFormDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the feedback form you'd like to fetch.","example":"9b17887e-5add-49e8-9a03-ffffa669aa2f"}},"required":["feedbackFormDefinitionId"],"additionalProperties":false},"FeedbackFormDefinitionListRequest":{"type":"object","properties":{"syncToken":{"description":"A sync token to retrieve only feedback form definitions updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of feedback form definitions to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":100},{"type":"null"}]},"includeArchived":{"description":"Whether to include archived feedback form definitions in the results.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},"FeedbackFormDefinitionListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackFormDefinition"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"c56d8409-8846-44a7-b09e-8959154bcf17","organizationId":"ec647f56-f27a-49a1-84af-021ad0a19f21","title":"Default Feedback Form","isArchived":false,"isDefaultForm":true,"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"dbf36925-0161-4f40-8a04-fcb49e5bbdb0","type":"ValueSelect","path":"overall_recommendation","humanReadablePath":"Overall Recommendation","title":"Overall Recommendation","isNullable":false,"selectableValues":[{"label":"4 - Strong Yes","value":"4"},{"label":"3 - Yes","value":"3"}]}}]}]},"interviewId":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"FeedbackFormDefinitionInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/FeedbackFormDefinition"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"c56d8409-8846-44a7-b09e-8959154bcf17","organizationId":"ec647f56-f27a-49a1-84af-021ad0a19f21","title":"Default Feedback Form","isArchived":false,"isDefaultForm":true,"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"dbf36925-0161-4f40-8a04-fcb49e5bbdb0","type":"ValueSelect","path":"overall_recommendation","humanReadablePath":"Overall Recommendation","title":"Overall Recommendation","isNullable":false,"selectableValues":[{"label":"4 - Strong Yes","value":"4"},{"label":"3 - Yes","value":"3"}]}}]}]},"interviewId":null}}},"PublicApiFileUploadContext":{"type":"string","enum":["CandidateResume","CandidateFiles","ApplicationForm"],"description":"The context for the file upload","title":"Public API File Upload Context","examples":["CandidateResume"]},"FileUploadHandle":{"type":"object","properties":{"handle":{"type":"string","description":"An encrypted handle to pass to a follow-up API call after the file has been uploaded"},"url":{"type":"string","format":"uri","description":"The presigned URL to upload the file to via a multipart/form-data POST request"},"fields":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Form fields that must be included before the file field in the multipart upload request"}},"required":["handle","url","fields"],"additionalProperties":false},"FileCreateFileUploadHandleRequest":{"type":"object","properties":{"fileUploadContext":{"description":"The context for the file upload. Use CandidateResume for resume uploads, CandidateFiles for general file uploads, and ApplicationForm for file fields in application form submissions.","$ref":"#/components/schemas/PublicApiFileUploadContext"},"filename":{"type":"string","minLength":1,"description":"The name of the file being uploaded, including extension","example":"resume.pdf"},"contentType":{"type":"string","minLength":1,"description":"The MIME type of the file being uploaded","example":"application/pdf"},"contentLength":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The size of the file in bytes","example":102400}},"required":["fileUploadContext","filename","contentType","contentLength"],"additionalProperties":false},"FileCreateFileUploadHandleSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/FileUploadHandle"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"handle":"encrypted-file-upload-handle","url":"https://uploads.example.com/","fields":{"key":"organization/file/resume.pdf","acl":"private"}}}},"FileInfoRequest":{"type":"object","properties":{"fileHandle":{"type":"string","description":"A file handle retrieved from the public API","example":"eyJoYW5kbGUiOnsidHlwZSI6IkNhbmRpZGF0ZUZpbGUiLCJmaWxlSWQiOiIxNTk1ZTRmYy04MTQwLTQ1NGUtYTI1ZC04NTNiOTQ3ZWNmYzgiLCJvd25lcklkIjoiYmY5NGZlNmMtMjU3MS00NzQ1LWE1OWEtNTA5MjE3ODI3MDVlIn0sInNpZ25hdHVyZSI6IkFqclpjT0VlTXUwdWxLZlRCS05iMWRkbDdHcjVIWFVmZzNrS0NPL1dWWjg9IiwidmVyc2lvbiI6IjEilQ"}},"required":["fileHandle"],"additionalProperties":false},"FileInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"object","properties":{"url":{"type":"string","description":"The url of the file"}},"required":["url"],"additionalProperties":false}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"url":"https://s3.amazonaws.com/..."}}},"HiringTeamRoleSummary":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the hiring team role"},"title":{"type":"string","description":"The title of the hiring team role","example":"Recruiter"}},"required":["id","title"],"additionalProperties":false},"HiringTeamRoleListRequest":{"type":"object","properties":{"namesOnly":{"default":true,"description":"When set to true (the default), an array of role titles is returned. When set to false, an array of objects that include the id and title of the role is returned.","type":"boolean"}},"required":["namesOnly"],"additionalProperties":false},"HiringTeamRoleListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"array","items":{"$ref":"#/components/schemas/HiringTeamRoleSummary"}}]}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":["Recruiter"]}},"Interview":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview"},"title":{"type":"string","description":"The internal title of the interview"},"externalTitle":{"type":"string","description":"The title of the interview shown to candidates"},"type":{"type":"string","enum":["Assessment","Interview","InterviewWithoutSchedule","TakeHome","Debrief"],"description":"The interview definition type, such as Interview, TakeHome, or Debrief"},"isArchived":{"type":"boolean","description":"Whether the interview is archived"},"isDebrief":{"type":"boolean","description":"Whether the interview is a debrief"},"isFeedbackRequired":{"type":"boolean","description":"Whether feedback is required for this interview"},"isFeedbackRequested":{"type":"boolean","description":"Whether feedback is requested for this interview"},"instructionsHtml":{"description":"The interview instructions rendered as HTML","anyOf":[{"type":"string"},{"type":"null"}]},"instructionsPlain":{"description":"The interview instructions rendered as plain text","anyOf":[{"type":"string"},{"type":"null"}]},"jobId":{"description":"The unique identifier for the job associated with this interview, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"feedbackFormDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the feedback form definition used by this interview"}},"required":["id","title","externalTitle","type","isArchived","isDebrief","isFeedbackRequired","isFeedbackRequested","feedbackFormDefinitionId"],"additionalProperties":false},"InterviewInfoRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the interview whose details will be fetched","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id"],"additionalProperties":false},"InterviewInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Interview"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Technical Interview","externalTitle":"Technical Interview","type":"Interview","isArchived":false,"isDebrief":false,"isFeedbackRequired":true,"isFeedbackRequested":true,"instructionsHtml":"<p>Use the scorecard to evaluate the candidate.</p>","instructionsPlain":"Use the scorecard to evaluate the candidate.","jobId":"2cb69137-763a-4d6f-8f17-bbc3564ecb2e","feedbackFormDefinitionId":"07189c2e-cacd-489d-8946-165acacc386f"}}},"InterviewListRequest":{"type":"object","properties":{"includeArchived":{"description":"When true, includes archived interviews in the response. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]},"includeNonSharedInterviews":{"description":"If true, interviews that are associated with specific jobs will be included in the response. Shared interviews that are not associated with a specific job can be scheduled for applications to any job. Interviews that are not shared can only be scheduled for applications to the job they are associated with. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]},"excludeArchivedScheduleTemplateInterviews":{"description":"If true, interviews local to archived schedule templates are omitted from the response. This parameter only has an effect when `includeNonSharedInterviews` is also set to true. Shared interviews (not associated with any schedule template) are always included regardless of this setting. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of interviews to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only interviews updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"InterviewListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Interview"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Technical Interview","externalTitle":"Technical Interview","type":"Interview","isArchived":false,"isDebrief":false,"isFeedbackRequired":true,"isFeedbackRequested":true,"instructionsHtml":"<p>Use the scorecard to evaluate the candidate.</p>","instructionsPlain":"Use the scorecard to evaluate the candidate.","jobId":"2cb69137-763a-4d6f-8f17-bbc3564ecb2e","feedbackFormDefinitionId":"07189c2e-cacd-489d-8946-165acacc386f"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"InterviewScheduleStatus":{"type":"string","enum":["NeedsScheduling","SchedulingRequested","WaitingOnCandidateBooking","WaitingOnCandidateAvailability","CandidateAvailabilitySubmitted","Scheduled","WaitingOnFeedback","Complete","Cancelled","OnHold","Unknown"],"description":"The current status of the interview schedule"},"InterviewerPoolBrief":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interviewer pool"},"title":{"type":"string","description":"The title of the interviewer pool"},"isArchived":{"type":"boolean","description":"Whether the interviewer pool is archived"}},"required":["id","title","isArchived"],"additionalProperties":false},"InterviewerWithPoolUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}],"description":"The user's email address"},"globalRole":{"$ref":"#/components/schemas/GlobalRole"},"isEnabled":{"type":"boolean","description":"Whether the user is enabled (not deactivated)"},"updatedAt":{"type":"string","description":"The timestamp when the user was last updated (ISO 8601 format)"},"managerId":{"description":"The unique identifier for the user's manager","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customFields":{"description":"Custom fields associated with the user (only included when requested)","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"trainingRole":{"description":"The interviewer's training role for this interview, if any","anyOf":[{"type":"string"},{"type":"null"}]},"interviewerPool":{"description":"The interviewer pool associated with this interviewer, if any","anyOf":[{"$ref":"#/components/schemas/InterviewerPoolBrief"},{"type":"null"}]},"isFeedbackRequired":{"type":"boolean","description":"Whether feedback is required from this interviewer"}},"required":["id","firstName","lastName","email","globalRole","isEnabled","updatedAt","isFeedbackRequired"],"additionalProperties":false},"InterviewEvent":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview event"},"interviewId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview for this event"},"interviewScheduleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview schedule for this event"},"interviewerUserIds":{"description":"The ids of the users interviewing in this event","anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"interviewers":{"type":"array","items":{"$ref":"#/components/schemas/InterviewerWithPoolUser"},"description":"The users interviewing in this event"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the interview event was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the interview event was last updated"},"startTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The scheduled start time of the interview event"},"endTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The scheduled end time of the interview event"},"feedbackLink":{"type":"string","format":"uri","description":"The link interviewers can use to submit feedback"},"location":{"description":"The location for the interview event, if any","anyOf":[{"type":"string"},{"type":"null"}]},"meetingLink":{"description":"The meeting link for the interview event, if any","anyOf":[{"type":"string"},{"type":"null"}]},"interviewerCalendarEventId":{"description":"The external calendar event id for the interviewer's calendar event","anyOf":[{"type":"string"},{"type":"null"}]},"hasSubmittedFeedback":{"type":"boolean","description":"Whether feedback has been submitted for this interview event"},"extraData":{"description":"Additional metadata associated with the interview event","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"interview":{"description":"The interview details for this event, if included","anyOf":[{"$ref":"#/components/schemas/Interview"},{"type":"null"}]},"notetakerTranscriptId":{"description":"The id of the notetaker transcript for this event, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","interviewId","interviewScheduleId","interviewers","createdAt","updatedAt","startTime","endTime","feedbackLink","hasSubmittedFeedback"],"additionalProperties":false},"InterviewSchedule":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview schedule"},"status":{"$ref":"#/components/schemas/InterviewScheduleStatus"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application for this interview schedule"},"interviewStageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview stage for this interview schedule"},"scheduledBy":{"anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}],"description":"The user who scheduled the interview schedule, if any"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the interview schedule was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the interview schedule was last updated"},"interviewEvents":{"type":"array","items":{"$ref":"#/components/schemas/InterviewEvent"},"description":"The interview events that make up this interview schedule"}},"required":["id","status","applicationId","interviewStageId","scheduledBy","createdAt","updatedAt","interviewEvents"],"additionalProperties":false},"InterviewScheduleCancelRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview schedule to cancel","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"allowReschedule":{"description":"Whether or not this interview schedule can be rescheduled.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["id"],"additionalProperties":false},"InterviewScheduleCancelSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewSchedule"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","status":"Cancelled","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","scheduledBy":null,"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","interviewEvents":[]}}},"InterviewScheduleCreateRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application for this interview schedule","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewEvents":{"type":"array","items":{"type":"object","properties":{"startTime":{"type":"string","description":"The start time of this event","example":"2023-01-30T15:00:00.000Z"},"endTime":{"type":"string","description":"The end time of this event","example":"2023-01-30T16:00:00.000Z"},"interviewers":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the user in Ashby","example":"test@ashbyhq.com"},"feedbackRequired":{"description":"Whether this interviewer is required to provide feedback","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["email"],"additionalProperties":false},"description":"The interviewers for this event"},"extraData":{"description":"Key-value pairs of additional metadata to store on the event. Keys must be ≤100 characters, values ≤512 characters, and the total size must be under 1kb.","example":{"partner_external_object_id":"12345","partner_additional_data":"f763ba0e4"},"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"interviewId":{"description":"The id of the interview used in this event. If no value is provided, the organization's default interview will be used.","example":"46648e83-f28f-43c4-a2a0-58e0599cff41","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["startTime","endTime","interviewers"],"additionalProperties":false},"description":"The list of events that make up this interview schedule"}},"required":["applicationId","interviewEvents"],"additionalProperties":false},"InterviewScheduleCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewSchedule"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","status":"Cancelled","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","scheduledBy":null,"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","interviewEvents":[]}}},"InterviewScheduleListRequest":{"type":"object","properties":{"applicationId":{"description":"The id of the application, for which to fetch interview schedules","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewStageId":{"description":"The id of the interview stage, for which to fetch interview schedules","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createdAfter":{"description":"The API will return data after this date, which is the time since the unix epoch in milliseconds","anyOf":[{"type":"number"},{"type":"null"}]},"cursor":{"description":"Opaque cursor indicating which page of results to fetch","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]}},"additionalProperties":false},"InterviewScheduleListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/InterviewSchedule"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","status":"Cancelled","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","scheduledBy":null,"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","interviewEvents":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"InterviewScheduleUpdateRequest":{"type":"object","properties":{"interviewScheduleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview schedule to update. Only interview schedules created using the API key making the request can be updated.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewEvent":{"description":"An event (or array of events) on the interview schedule to create or update. To update an event, its `interviewEventId` must be included in the request.","anyOf":[{"anyOf":[{"type":"object","properties":{"startTime":{"type":"string","description":"The start time of this event","example":"2023-01-30T15:00:00.000Z"},"endTime":{"type":"string","description":"The end time of this event","example":"2023-01-30T16:00:00.000Z"},"interviewers":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the user in Ashby","example":"test@ashbyhq.com"},"feedbackRequired":{"description":"Whether this interviewer is required to provide feedback","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["email"],"additionalProperties":false},"description":"The interviewers for this event"},"extraData":{"description":"Key-value pairs of additional metadata to store on the event. Keys must be ≤100 characters, values ≤512 characters, and the total size must be under 1kb.","example":{"partner_external_object_id":"12345","partner_additional_data":"f763ba0e4"},"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"interviewId":{"description":"The id of the interview used in this event. If no value is provided, the organization's default interview will be used.","example":"46648e83-f28f-43c4-a2a0-58e0599cff41","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewEventId":{"description":"The id of an interview event to update. Required to update an existing event; omit to create a new event.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["startTime","endTime","interviewers"],"additionalProperties":false},{"type":"array","items":{"type":"object","properties":{"startTime":{"type":"string","description":"The start time of this event","example":"2023-01-30T15:00:00.000Z"},"endTime":{"type":"string","description":"The end time of this event","example":"2023-01-30T16:00:00.000Z"},"interviewers":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the user in Ashby","example":"test@ashbyhq.com"},"feedbackRequired":{"description":"Whether this interviewer is required to provide feedback","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["email"],"additionalProperties":false},"description":"The interviewers for this event"},"extraData":{"description":"Key-value pairs of additional metadata to store on the event. Keys must be ≤100 characters, values ≤512 characters, and the total size must be under 1kb.","example":{"partner_external_object_id":"12345","partner_additional_data":"f763ba0e4"},"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"interviewId":{"description":"The id of the interview used in this event. If no value is provided, the organization's default interview will be used.","example":"46648e83-f28f-43c4-a2a0-58e0599cff41","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"interviewEventId":{"description":"The id of an interview event to update. Required to update an existing event; omit to create a new event.","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["startTime","endTime","interviewers"],"additionalProperties":false}}]},{"type":"null"}]},"interviewEventIdToCancel":{"description":"The id (or array of ids) of interview events to cancel.","anyOf":[{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"array","items":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}}]},{"type":"null"}]},"allowFeedbackDeletion":{"description":"By default, events with submitted feedback cannot be cancelled because cancellation deletes the associated feedback. Pass `true` to allow cancelling events with submitted feedback.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["interviewScheduleId"],"additionalProperties":false},"InterviewScheduleUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewSchedule"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","status":"Cancelled","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","scheduledBy":null,"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","interviewEvents":[]}}},"Location":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the location"},"name":{"type":"string","description":"The name of the location"},"externalName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An alternate candidate-facing name for this location used on job boards and in the API"},"isArchived":{"type":"boolean","description":"Whether the location is archived"},"isRemote":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Deprecated. Use workplaceType instead."},"address":{"anyOf":[{"type":"object","properties":{"postalAddress":{"type":"object","properties":{"addressCountry":{"description":"The country for the location address","type":"string"},"addressRegion":{"description":"The region for the location address","type":"string"},"addressLocality":{"description":"The locality for the location address","type":"string"},"postalCode":{"description":"The postal code for the location address","type":"string"},"streetAddress":{"description":"The street address for the location","type":"string"}},"additionalProperties":{},"description":"The postal address for the location"}},"required":["postalAddress"],"additionalProperties":{},"description":"The address for the location"},{"type":"null"}],"description":"The address for the location"},"parentLocationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The unique identifier for the parent location hierarchy, if any"},"type":{"type":"string","enum":["Location","LocationHierarchy"],"description":"The type of the location component"},"workplaceType":{"anyOf":[{"type":"string","enum":["OnSite","Hybrid","Remote"]},{"type":"null"}],"description":"The type of workplace"},"extraData":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}],"description":"Structured key-value information for your own use and reference. Do not store personally identifiable information in this field."}},"required":["id","name","externalName","isArchived","isRemote","address","parentLocationId","type","workplaceType","extraData"],"additionalProperties":false},"LocationRestoreRequest":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location to restore","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["locationId"],"additionalProperties":false},"LocationMoveRequest":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"parentLocationHierarchyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the parent location hierarchy","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["locationId","parentLocationHierarchyId"],"additionalProperties":false},"LocationArchiveRequest":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["locationId"],"additionalProperties":false},"LocationInfoRequest":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location to fetch","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["locationId"],"additionalProperties":false},"LocationListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only locations updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of locations to return per page.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]},"includeArchived":{"description":"When true, includes archived items. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]},"includeLocationHierarchy":{"description":"If true, the response will include the location hierarchy (regions). Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},"LocationCreateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the location."},"type":{"type":"string","enum":["Location","LocationHierarchy"],"description":"A Location represents an actual location that jobs and employees can be associated with. A Location Hierarchy is a grouping of locations or other location hierarchies."},"address":{"description":"The address of the location.","anyOf":[{"type":"object","properties":{"postalAddress":{"type":"object","properties":{"addressCountry":{"description":"The country for the location address","type":"string"},"addressRegion":{"description":"The region for the location address","type":"string"},"addressLocality":{"description":"The locality for the location address","type":"string"},"postalCode":{"description":"The postal code for the location address","type":"string"},"streetAddress":{"description":"The street address for the location","type":"string"}},"additionalProperties":{},"description":"The postal address for the location"}},"required":["postalAddress"],"additionalProperties":{},"description":"The address for the location"},{"type":"null"}]},"parentLocationId":{"description":"The id of the location's parent.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"isRemote":{"description":"Whether the location should be labeled as remote. LocationHierarchies cannot be labeled as remote.","anyOf":[{"type":"boolean"},{"type":"null"}]},"workplaceType":{"description":"The type of workplace. LocationHierarchies cannot be labeled with a workplaceType.","anyOf":[{"type":"string","enum":["OnSite","Hybrid","Remote"]},{"type":"null"}]},"externalName":{"description":"An alternate candidate-facing name for this location used on job boards and in the API.","anyOf":[{"type":"string"},{"type":"null"}]},"extraData":{"description":"Structured key-value information for your own use and reference. Do not store personally identifiable information in this field.","example":{"partner_external_object_id":"12345","partner_additional_data":"f763ba0e4"},"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]}},"required":["name","type"],"additionalProperties":false},"LocationUpdateAddressRequest":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"address":{"description":"The address of the location. Pass `null` to clear.","anyOf":[{"type":"object","properties":{"postalAddress":{"type":"object","properties":{"addressCountry":{"description":"The country for the location address","type":"string"},"addressRegion":{"description":"The region for the location address","type":"string"},"addressLocality":{"description":"The locality for the location address","type":"string"},"postalCode":{"description":"The postal code for the location address","type":"string"},"streetAddress":{"description":"The street address for the location","type":"string"}},"additionalProperties":{},"description":"The postal address for the location"}},"required":["postalAddress"],"additionalProperties":{},"description":"The address for the location"},{"type":"null"}]}},"required":["locationId"],"additionalProperties":false},"LocationUpdateNameRequest":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"name":{"type":"string","description":"The name of the location"}},"required":["locationId","name"],"additionalProperties":false},"LocationUpdateExternalNameRequest":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"externalName":{"description":"An alternate candidate-facing name for this location used on job boards and in the API. Pass `null` to clear.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["locationId"],"additionalProperties":false},"LocationUpdateWorkplaceTypeRequest":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"workplaceType":{"anyOf":[{"type":"string","enum":["OnSite","Hybrid","Remote"]},{"type":"null"}],"description":"The type of workplace. LocationHierarchies cannot be labeled with a workplaceType."}},"required":["locationId","workplaceType"],"additionalProperties":false},"LocationRestoreSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"LocationMoveSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"LocationArchiveSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"LocationInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"LocationListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"LocationCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"LocationUpdateAddressSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"LocationUpdateNameSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"LocationUpdateExternalNameSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"LocationUpdateWorkplaceTypeSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Location"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","name":"Bay Area Office","externalName":"San Francisco Office","isArchived":false,"isRemote":false,"address":{"postalAddress":{"addressCountry":"United States","addressRegion":"California","addressLocality":"San Francisco","postalCode":"94108","streetAddress":"49 Geary St Suite 411"}},"parentLocationId":null,"type":"Location","workplaceType":"Hybrid","extraData":{"partner_external_object_id":"12345"}}}},"OpeningCustomField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"description":"Whether the custom field is private and requires additional permissions","type":"boolean"},"title":{"type":"string","description":"The title of the custom field"},"valueLabel":{"description":"The label of the custom field value for select fields","anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The ISO currency code"}},"required":["value","currencyCode"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The custom field value type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","description":"The custom field value type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The ISO currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false}],"description":"The value of the custom field"}},"required":["id","title","value"],"additionalProperties":false},"OpeningHiringTeamRole":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The user's email address"},"role":{"type":"string","description":"The user's role on the opening hiring team"}},"required":["userId","firstName","lastName","email","role"],"additionalProperties":false},"OpeningVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the opening version"},"identifier":{"type":"string","description":"The human-readable opening identifier"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The opening description"},"authorId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The unique identifier for the author"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the opening version was created"},"targetHireDate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The target hire date for the opening"},"targetStartDate":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The target start date for the opening"},"isBackfill":{"type":"boolean","description":"Whether the opening is a backfill"},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"],"description":"The employment type for the opening"},"teamId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The unique identifier for the team"},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The unique identifiers for jobs linked to the opening"},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The unique identifiers for locations linked to the opening"},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/OpeningHiringTeamRole"},"description":"The hiring team roles assigned to the opening"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/OpeningCustomField"},"description":"Custom fields associated with the opening"}},"required":["id","identifier","description","authorId","createdAt","targetHireDate","targetStartDate","isBackfill","employmentType","teamId","jobIds","locationIds","hiringTeam","customFields"],"additionalProperties":false},"Opening":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the opening"},"openedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"The timestamp when the opening was opened"},"closedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"The timestamp when the opening was closed"},"isArchived":{"type":"boolean","description":"Whether the opening is archived"},"closeReasonId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The unique identifier for the close reason"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"The timestamp when the opening was archived"},"openingState":{"type":"string","enum":["Draft","Approved","Open","Closed","Filled"],"description":"The current state of the opening"},"latestVersion":{"anyOf":[{"$ref":"#/components/schemas/OpeningVersion"},{"type":"null"}],"description":"The latest version of the opening"}},"required":["id","openedAt","closedAt","isArchived","closeReasonId","archivedAt","openingState","latestVersion"],"additionalProperties":false},"OpeningAddLocationRequest":{"type":"object","properties":{"openingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location to add to the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["openingId","locationId"],"additionalProperties":false},"OpeningRemoveLocationRequest":{"type":"object","properties":{"openingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location to remove from the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["openingId","locationId"],"additionalProperties":false},"OpeningInfoRequest":{"type":"object","properties":{"openingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["openingId"],"additionalProperties":false},"OpeningListRequest":{"type":"object","properties":{"createdAfter":{"description":"The API will return data after this date, which is the time since the unix epoch in milliseconds","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only openings updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of openings to return per page.","example":25,"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"additionalProperties":false},"OpeningSearchRequest":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the opening you want to search for"}},"required":["identifier"],"additionalProperties":false},"OpeningCreateRequest":{"type":"object","properties":{"identifier":{"description":"The human-readable identifier of the opening","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The description of the opening","anyOf":[{"type":"string"},{"type":"null"}]},"teamId":{"description":"The id of the department or team associated with the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"locationIds":{"description":"The ids of the locations associated with the opening","anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"jobIds":{"description":"The ids of the jobs associated with the opening","anyOf":[{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"type":"null"}]},"targetHireDate":{"description":"The date (in YYYY-MM-DD format) by which you intend to hire against this opening","anyOf":[{"type":"string"},{"type":"null"}]},"targetStartDate":{"description":"The date (in YYYY-MM-DD format) by which you intend someone hired against this opening will start employment","anyOf":[{"type":"string"},{"type":"null"}]},"isBackfill":{"description":"Whether this opening is intended to backfill a previous employee","anyOf":[{"type":"boolean"},{"type":"null"}]},"employmentType":{"description":"The employment type for this opening","anyOf":[{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},{"type":"null"}]},"openingState":{"description":"The state the opening should be created in. Defaults to `Draft`. If not Draft, additional validation will be performed.","anyOf":[{"type":"string","enum":["Draft","Approved","Open","Closed"]},{"type":"null"}]}},"additionalProperties":false},"OpeningUpdateRequest":{"type":"object","properties":{"openingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the opening to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"identifier":{"description":"The human-readable identifier of the opening","anyOf":[{"type":"string"},{"type":"null"}]},"description":{"description":"The description of the opening","anyOf":[{"type":"string"},{"type":"null"}]},"teamId":{"description":"The id of the department or team associated with the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"targetHireDate":{"description":"The date (in YYYY-MM-DD format) by which you intend to hire against this opening","anyOf":[{"type":"string"},{"type":"null"}]},"targetStartDate":{"description":"The date (in YYYY-MM-DD format) by which you intend someone hired against this opening will start employment","anyOf":[{"type":"string"},{"type":"null"}]},"isBackfill":{"description":"Whether this opening is intended to backfill a previous employee","anyOf":[{"type":"boolean"},{"type":"null"}]},"employmentType":{"description":"The employment type for this opening","anyOf":[{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},{"type":"null"}]}},"required":["openingId"],"additionalProperties":false},"OpeningSetArchivedRequest":{"type":"object","properties":{"openingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the opening you want to archive or unarchive","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"archive":{"type":"boolean","description":"The new archived state you want to update the opening to"}},"required":["openingId","archive"],"additionalProperties":false},"OpeningSetOpeningStateRequest":{"type":"object","properties":{"openingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the opening you want to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openingState":{"type":"string","enum":["Draft","Approved","Open","Closed"],"description":"The new state you want to update the opening to"},"closeReasonId":{"description":"The id of the close reason if you are setting the state to closed","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["openingId","openingState"],"additionalProperties":false},"OpeningAddJobRequest":{"type":"object","properties":{"openingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job to add to the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["openingId","jobId"],"additionalProperties":false},"OpeningRemoveJobRequest":{"type":"object","properties":{"openingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job to remove from the opening","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["openingId","jobId"],"additionalProperties":false},"OpeningAddLocationSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"OpeningRemoveLocationSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"OpeningInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"OpeningListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Opening"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"OpeningSearchSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Opening"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}]}},"OpeningCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"OpeningUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"OpeningSetArchivedSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"OpeningSetOpeningStateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"OpeningAddJobSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"OpeningRemoveJobSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Opening"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"595ae947-e308-4a36-af06-70b7f6e0fb82","openedAt":null,"closedAt":null,"isArchived":false,"closeReasonId":null,"archivedAt":null,"openingState":"Approved","latestVersion":{"id":"3f60be56-95d3-4e5f-a54a-cccfc8056dc2","identifier":"119471","description":"119471","authorId":"eefc52e9-f227-4844-a8a4-9fbfb4a90e5d","createdAt":"2026-04-23T20:32:13.800Z","targetHireDate":null,"targetStartDate":null,"isBackfill":false,"employmentType":"FullTime","teamId":null,"jobIds":[],"locationIds":["6f5c032e-c14e-4197-94f2-e3218cff8478"],"hiringTeam":[],"customFields":[]}}}},"JobStatus":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"JobHiringTeamRole":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The user's email address"},"role":{"type":"string","description":"The user's role on the job's hiring team"}},"required":["userId","firstName","lastName","email","role"],"additionalProperties":false},"JobCustomField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field definition"},"isPrivate":{"type":"boolean","description":"Whether the custom field is private"},"title":{"type":"string","description":"The title of the custom field"},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"object","properties":{"country":{"description":"The country of the location","type":"string"},"region":{"description":"The region of the location","type":"string"},"city":{"description":"The city of the location","type":"string"}},"additionalProperties":{}},{"type":"null"}],"description":"The value of the custom field"},"valueLabel":{"description":"The human-readable label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"null"}]}}]},{"type":"null"}]}},"required":["id","isPrivate","title","value"],"additionalProperties":false},"JobCompensationTierComponent":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The component's unique id"},"summary":{"type":"string","description":"The summary of this component as shown on Ashby-hosted job boards"},"compensationType":{"type":"string","enum":["Salary","EquityPercentage","EquityCashValue","Bonus","Commission"],"description":"The type of compensation this component represents"},"interval":{"type":"string","enum":["NONE","1 TIME","1 HOUR","1 DAY","1 WEEK","2 WEEK","1 MONTH","2 MONTH","1 YEAR","6 MONTH","0.5 MONTH","3 MONTH"],"description":"The frequency at which this compensation is given"},"label":{"description":"An optional label that describes this compensation range to applicants","anyOf":[{"type":"string"},{"type":"null"}]},"currencyCode":{"description":"For non `EquityPercentage` components, the ISO 4217 currency code of the compensation range","anyOf":[{"type":"string"},{"type":"null"}]},"minValue":{"description":"The lower end of the compensation range","anyOf":[{"type":"number"},{"type":"null"}]},"maxValue":{"description":"The higher end of the compensation range","anyOf":[{"type":"number"},{"type":"null"}]}},"required":["id","summary","compensationType","interval"],"additionalProperties":false},"JobCompensationTier":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The compensation tier's unique id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A label that describes the entire range to applicants"},"additionalInformation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Supplementary information about the compensation"},"components":{"type":"array","items":{"$ref":"#/components/schemas/JobCompensationTierComponent"},"description":"The individual components that make up this compensation range"},"tierSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A summary of the tier's components in the same format shown on job boards"}},"required":["id","title","additionalInformation","components","tierSummary"],"additionalProperties":false},"JobCompensation":{"type":"object","properties":{"compensationTiers":{"type":"array","items":{"$ref":"#/components/schemas/JobCompensationTier"},"description":"The compensation ranges that can be offered to applicants for this job"}},"required":["compensationTiers"],"additionalProperties":false},"Job":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The job's unique identifier"},"title":{"type":"string","description":"The title of the job"},"confidential":{"type":"boolean","description":"Whether the job is confidential"},"status":{"description":"The current status of the job","$ref":"#/components/schemas/JobStatus"},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"],"description":"The employment type for the job"},"locationId":{"description":"The id of the location associated with the job","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"departmentId":{"description":"The id of the department or team associated with the job","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"defaultInterviewPlanId":{"description":"The id of the default interview plan for this job. A job cannot be opened without a default interview plan.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"interviewPlanIds":{"description":"The ids of all interview plans associated with the job","type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"jobPostingIds":{"description":"The ids of all job postings associated with the job","type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"customRequisitionId":{"description":"The custom requisition id for the job","anyOf":[{"type":"string"},{"type":"null"}]},"brandId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the brand to use for this job"},"hiringTeam":{"type":"array","items":{"$ref":"#/components/schemas/JobHiringTeamRole"},"description":"The hiring team for the job"},"openings":{"description":"The openings linked to this job. Only included when the `openings` expand parameter is provided.","type":"array","items":{"$ref":"#/components/schemas/Opening"}},"location":{"description":"The location for this job. Only included when the `location` expand parameter is provided.","$ref":"#/components/schemas/Location"},"compensation":{"description":"The compensation tiers for this job. Only included when the `compensation` expand parameter is provided.","$ref":"#/components/schemas/JobCompensation"},"customFields":{"description":"Custom field values associated with the job","type":"array","items":{"$ref":"#/components/schemas/JobCustomField"}},"author":{"description":"The user who created the job","$ref":"#/components/schemas/User"},"createdAt":{"type":"string","description":"The timestamp when the job was created"},"updatedAt":{"type":"string","description":"The timestamp when the job was last updated"},"openedAt":{"description":"The timestamp when the job was opened","anyOf":[{"type":"string"},{"type":"null"}]},"closedAt":{"description":"The timestamp when the job was closed","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","title","confidential","status","employmentType","brandId","hiringTeam","createdAt","updatedAt"],"additionalProperties":false},"JobListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of jobs to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only jobs updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"status":{"description":"When supplied, only jobs with the provided status(es) are returned. Accepted values are `Draft`, `Open`, `Closed`, and `Archived` (case-insensitive).","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"createdAfter":{"description":"Return jobs created at or after this date. Unix timestamp in milliseconds.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"openedAfter":{"description":"Return jobs opened after this date. Unix timestamp in milliseconds.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"openedBefore":{"description":"Return jobs opened before this date. Unix timestamp in milliseconds.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"closedAfter":{"description":"Return jobs closed after this date. Unix timestamp in milliseconds.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"closedBefore":{"description":"Return jobs closed before this date. Unix timestamp in milliseconds.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"includeUnpublishedJobPostingsIds":{"description":"Whether to include unpublished job posting ids in the response","anyOf":[{"type":"boolean"},{"type":"null"}]},"expand":{"description":"Expand the result with related objects. Supported values are `openings` and `location`.","anyOf":[{"type":"array","items":{"type":"string","enum":["opening","openings","location"]}},{"type":"null"}]}},"additionalProperties":false},"JobInfoRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job to fetch","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"includeUnpublishedJobPostingsIds":{"description":"Whether to include unpublished job posting ids in the response","anyOf":[{"type":"boolean"},{"type":"null"}]},"expand":{"description":"Expand the result with related objects. Supported values are `openings`, `location`, and `compensation`.","anyOf":[{"type":"array","items":{"type":"string","enum":["opening","openings","location","compensation"]}},{"type":"null"}]}},"required":["id"],"additionalProperties":false},"JobCreateRequest":{"type":"object","properties":{"title":{"type":"string","minLength":1,"description":"The title of the job","example":"Software Engineer"},"teamId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the department or team associated with the job","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the location associated with the job","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"defaultInterviewPlanId":{"description":"The id of the default interview plan for this job. A job cannot be opened without a default interview plan.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"jobTemplateId":{"description":"The id of the job template to use for this job. Only active job templates can be used to create a job.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"brandId":{"description":"The id of the brand to use for this job","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["title","teamId","locationId"],"additionalProperties":false},"JobUpdateRequest":{"type":"object","properties":{"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the job to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"description":"A new title for the job","example":"Software Engineer","type":"string","minLength":1},"teamId":{"description":"The new team to associate with the job. Pass `null` (together with another field to update) to remove the existing team.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"locationId":{"description":"The new location to associate with the job","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"defaultInterviewPlanId":{"description":"The new default interview plan to associate with the job","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customRequisitionId":{"description":"The new custom requisition id for the job. Pass `null` (together with another field to update) to clear the existing value.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["jobId"],"additionalProperties":false},"JobUpdateCompensationRequest":{"type":"object","properties":{"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the job to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"compensationTiers":{"type":"array","items":{"type":"object","properties":{"title":{"description":"A label that describes the entire range to applicants. Required when more than one tier is provided.","example":"Zone A","anyOf":[{"type":"string"},{"type":"null"}]},"additionalInformation":{"description":"Supplementary information about the compensation","example":"Signing bonus available","anyOf":[{"type":"string"},{"type":"null"}]},"components":{"type":"array","items":{"type":"object","properties":{"compensationType":{"type":"string","enum":["Salary","EquityPercentage","EquityCashValue","Bonus","Commission"],"description":"The type of compensation this component represents","example":"Salary"},"interval":{"type":"string","enum":["NONE","1 TIME","1 HOUR","1 DAY","1 WEEK","2 WEEK","1 MONTH","2 MONTH","1 YEAR","6 MONTH","0.5 MONTH","3 MONTH"],"description":"The frequency at which this compensation is given","example":"1 YEAR"},"label":{"description":"An optional label that describes this compensation range to applicants","anyOf":[{"type":"string"},{"type":"null"}]},"currencyCode":{"description":"For non `EquityPercentage` components, the ISO 4217 currency code of the compensation range","example":"EUR","anyOf":[{"type":"string"},{"type":"null"}]},"minValue":{"description":"The lower end of the compensation range","example":72023.45,"anyOf":[{"type":"number"},{"type":"null"}]},"maxValue":{"description":"The higher end of the compensation range","example":100000,"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["compensationType","interval"],"additionalProperties":false},"description":"The individual components that make up this compensation range"}},"required":["components"],"additionalProperties":false},"description":"The compensation tiers to set on the job. Pass an empty array to clear existing compensation."}},"required":["jobId","compensationTiers"],"additionalProperties":false},"JobSetStatusRequest":{"type":"object","properties":{"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the job to set the status of","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"status":{"description":"The status to apply to the job","$ref":"#/components/schemas/JobStatus"}},"required":["jobId","status"],"additionalProperties":false},"JobSearchRequest":{"type":"object","properties":{"title":{"description":"The title (or substring of a title) of the job to search for","example":"Software Engineer","anyOf":[{"type":"string"},{"type":"null"}]},"requisitionId":{"description":"The custom requisition id (or substring) of the job to search for","example":"REQ-2471","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"JobListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Job"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"JobInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Job"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}}},"JobCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Job"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Draft","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":null,"closedAt":null}}},"JobUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Job"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}}},"JobUpdateCompensationSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Job"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}}},"JobSetStatusSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Job"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}}},"JobSearchSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Job"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"1be42b8e-cafd-4beb-8121-f4981eb20f42","title":"Software Engineer","confidential":false,"status":"Open","employmentType":"FullTime","locationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","departmentId":"f9e52a51-a075-4116-a7b8-484deba69004","defaultInterviewPlanId":"595ae947-e308-4a36-af06-70b7f6e0fb82","interviewPlanIds":["595ae947-e308-4a36-af06-70b7f6e0fb82"],"jobPostingIds":[],"customRequisitionId":"ENG-01","brandId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","hiringTeam":[],"customFields":[],"createdAt":"2024-01-01T00:00:00.000Z","updatedAt":"2024-01-15T10:30:00.000Z","openedAt":"2024-01-02T00:00:00.000Z","closedAt":null}]}},"BriefingInterviewerTrainingRole":{"type":"string","enum":["Shadow","ReverseShadow"]},"BriefingInterviewer":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The user id of the interviewer"},"isFeedbackRequired":{"type":"boolean","description":"Whether feedback is required from this interviewer for this specific event."},"hasSubmittedFeedback":{"type":"boolean","description":"Whether this interviewer has already submitted a scorecard for this event."},"trainingRole":{"anyOf":[{"$ref":"#/components/schemas/BriefingInterviewerTrainingRole"},{"type":"null"}],"description":"The training-related role of the interviewer for this specific event. Returns null when the interviewer is qualified for interviewing (or Interviewer Training is not enabled)."},"user":{"description":"The full user record for this interviewer. Only included when the request was made with `expand: [\"interviewers\"]`.","anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"interviewerPool":{"description":"The interviewer pool this interviewer belongs to, if applicable. Only included when the request was made with `expand: [\"interviewers\"]`.","anyOf":[{"$ref":"#/components/schemas/InterviewerPoolBrief"},{"type":"null"}]}},"required":["userId","isFeedbackRequired","hasSubmittedFeedback","trainingRole"],"additionalProperties":false},"InterviewBriefingInfoRequest":{"type":"object","properties":{"interviewEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview event whose briefing should be returned.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"expand":{"description":"Choose to expand the result and include additional data for related objects.","anyOf":[{"type":"array","items":{"type":"string","enum":["feedbackFormDefinition","application","candidate","job","interview","interviewers"]}},{"type":"null"}]}},"required":["interviewEventId"],"additionalProperties":false},"InterviewBriefing":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The interview event's id","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application this briefing is for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewStageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview stage this event belongs to","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewers":{"type":"array","items":{"$ref":"#/components/schemas/BriefingInterviewer"},"description":"The interviewers assigned to this event. By default each entry contains a `userId` with status flags; pass `expand: [\"interviewers\"]` to include the full user and pool details."},"hasSubmittedFeedback":{"type":"boolean","description":"Whether any interviewer on this event has submitted a scorecard."},"feedbackFormDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the feedback form definition that should be used to render and submit feedback for this event.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"feedbackFormDefinition":{"description":"The full feedback form definition. Only included when the request was made with `expand: [\"feedbackFormDefinition\"]`.","$ref":"#/components/schemas/FeedbackFormDefinition"},"application":{"description":"The application associated with this briefing. Only included when the request was made with `expand: [\"application\"]`.","$ref":"#/components/schemas/Application"},"candidate":{"description":"The candidate associated with this briefing. Only included when the request was made with `expand: [\"candidate\"]`.","$ref":"#/components/schemas/Candidate"},"job":{"description":"The job associated with this briefing. Only included when the request was made with `expand: [\"job\"]`.","$ref":"#/components/schemas/Job"},"interview":{"description":"The interview associated with this briefing. Only included when the request was made with `expand: [\"interview\"]`.","$ref":"#/components/schemas/Interview"}},"required":["id","applicationId","interviewId","interviewStageId","interviewers","hasSubmittedFeedback","feedbackFormDefinitionId"],"additionalProperties":false},"InterviewBriefingInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewBriefing"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","applicationId":"9d34f544-c150-4d70-91c4-e8b0b4a72846","interviewId":"ff6c7d9d-71e3-4c9c-88b1-28824980c276","interviewStageId":"5a3f9c2b-71e3-4c9c-88b1-28824980c276","interviewers":[{"userId":"caea4d97-331d-46b1-a8e3-6b821c2214ef","isFeedbackRequired":true,"hasSubmittedFeedback":false,"trainingRole":null}],"hasSubmittedFeedback":false,"feedbackFormDefinitionId":"9b2cb8d9-1a6b-4d4f-9c5d-69ef7b9a9f12"}}},"InterviewEventListRequest":{"type":"object","properties":{"interviewScheduleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique ID of the interview schedule, for which to list interview events","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"expand":{"description":"Choose to expand the result and include additional data for related objects.","anyOf":[{"type":"array","items":{"type":"string","const":"interview"}},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use the nextCursor value from a previous response to fetch the next page.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only events updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"description":"Return only events created after this date, expressed as milliseconds since the Unix epoch.","example":1659979196538,"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["interviewScheduleId"],"additionalProperties":false},"InterviewEventListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/InterviewEvent"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","interviewId":"ff6c7d9d-71e3-4c9c-88b1-28824980c276","interviewScheduleId":"9d34f544-c150-4d70-91c4-e8b0b4a72846","interviewerUserIds":["caea4d97-331d-46b1-a8e3-6b821c2214ef"],"interviewers":[{"id":"caea4d97-331d-46b1-a8e3-6b821c2214ef","firstName":"Lindsay","lastName":"Bluth","email":"lindsay@bluth.com","globalRole":"Organization Admin","isEnabled":true,"updatedAt":"2026-04-25T02:46:46.230Z","trainingRole":null,"interviewerPool":null,"isFeedbackRequired":true}],"createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","startTime":"2026-04-26T15:00:00.000Z","endTime":"2026-04-26T16:00:00.000Z","feedbackLink":"https://app.ashbyhq.com/interview-briefings/4736b6d2-5c97-43a6-a7c6-0228bf079411/feedback","location":"Google Meet","meetingLink":"https://meet.google.com/abc-defg-hij","interviewerCalendarEventId":null,"hasSubmittedFeedback":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"InterviewPlan":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The interview plan's unique identifier"},"title":{"type":"string","description":"The title of the interview plan"},"isArchived":{"type":"boolean","description":"Whether the interview plan has been archived"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the interview plan was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the interview plan was last updated"}},"required":["id","title","isArchived","createdAt","updatedAt"],"additionalProperties":false},"InterviewPlanListRequest":{"type":"object","properties":{"includeArchived":{"description":"Whether archived interview plans should be included in the response","anyOf":[{"type":"boolean"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of interview plans to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only interview plans updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"InterviewPlanListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/InterviewPlan"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","title":"Engineering Interview Plan","isArchived":false,"createdAt":"2022-08-12T20:29:56.964Z","updatedAt":"2023-09-13T21:30:57.965Z"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"InterviewStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview stage"},"title":{"type":"string","description":"The title of the interview stage"},"type":{"type":"string","description":"The type of the interview stage (e.g. Active, Archived, Hired, PreInterviewScreen, Offer, Lead)"},"interviewPlanId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview plan this stage belongs to"},"orderInInterviewPlan":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The order of this stage within its interview plan (zero-indexed)"},"interviewStageGroupId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The id of the interview stage group this stage belongs to, if any"}},"required":["id","title","type","interviewPlanId","orderInInterviewPlan","interviewStageGroupId"],"additionalProperties":false},"InterviewStageInfoRequest":{"type":"object","properties":{"interviewStageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview stage to retrieve","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewStageId"],"additionalProperties":false},"InterviewStageListRequest":{"type":"object","properties":{"interviewPlanId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview plan to list stages for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"],"additionalProperties":false},"InterviewStageInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewStage"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Technical Interview","type":"Active","interviewPlanId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","orderInInterviewPlan":0,"interviewStageGroupId":null}}},"InterviewStageListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/InterviewStage"}},"moreDataAvailable":{"type":"boolean"}},"required":["success","results","moreDataAvailable"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Technical Interview","type":"Active","interviewPlanId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","orderInInterviewPlan":0,"interviewStageGroupId":null}],"moreDataAvailable":false}},"InterviewStageGroup":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview stage group","example":"84bfbed7-ed0a-496d-bb18-11b73369f666"},"title":{"type":"string","description":"The title of the interview stage group","example":"Technical Screening"},"order":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"The order of the interview stage group within an interview plan","example":1},"stageType":{"type":"string","enum":["Active","Archived","Hired","PreInterviewScreen","Offer","Lead"],"description":"The category of interview stage group","example":"Active"}},"required":["id","title","order","stageType"],"additionalProperties":false},"InterviewStageGroupListRequest":{"type":"object","properties":{},"additionalProperties":false},"InterviewStageGroupListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/InterviewStageGroup"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","title":"Technical Screening","order":1,"stageType":"Active"}]}},"InterviewerPoolTrainingPathStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The training stage's id"},"interviewerRole":{"type":"string","enum":["Shadow","ReverseShadow"],"description":"The role of the interviewer for this stage"},"interviewsRequired":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The number of interviews required for this stage"},"isArchived":{"type":"boolean","description":"Whether the training stage is archived"},"approvalRequired":{"type":"boolean","description":"Whether approval is required for this stage"},"approvers":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/User"}},{"type":"null"}],"description":"The users who can approve this stage"}},"required":["id","interviewerRole","interviewsRequired","isArchived","approvalRequired","approvers"],"additionalProperties":false},"InterviewerPoolTrainingPath":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The training path's id"},"enabled":{"type":"boolean","description":"Whether the training path is enabled"},"trainingStages":{"type":"array","items":{"$ref":"#/components/schemas/InterviewerPoolTrainingPathStage"},"description":"The training stages in this path"}},"required":["id","enabled","trainingStages"],"additionalProperties":false},"InterviewerPoolMember":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}],"description":"The user's email address"},"globalRole":{"$ref":"#/components/schemas/GlobalRole"},"isEnabled":{"type":"boolean","description":"Whether the user is enabled (not deactivated)"},"updatedAt":{"type":"string","description":"The timestamp when the user was last updated (ISO 8601 format)"},"managerId":{"description":"The unique identifier for the user's manager","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customFields":{"description":"Custom fields associated with the user (only included when requested)","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"isPaused":{"type":"boolean","description":"Whether the user is currently paused in this pool"}},"required":["id","firstName","lastName","email","globalRole","isEnabled","updatedAt","isPaused"],"additionalProperties":false},"InterviewerPoolTrainingProgress":{"type":"object","properties":{"trainingPathId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the training path the user is currently on"},"trainingPathStageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the training stage the user is currently in"},"interviewsCompleted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The number of interviews the user has completed in the current stage"}},"required":["trainingPathId","trainingPathStageId","interviewsCompleted"],"additionalProperties":false},"InterviewerPoolTrainingUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}],"description":"The user's email address"},"globalRole":{"$ref":"#/components/schemas/GlobalRole"},"isEnabled":{"type":"boolean","description":"Whether the user is enabled (not deactivated)"},"updatedAt":{"type":"string","description":"The timestamp when the user was last updated (ISO 8601 format)"},"managerId":{"description":"The unique identifier for the user's manager","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customFields":{"description":"Custom fields associated with the user (only included when requested)","type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"isPaused":{"type":"boolean","description":"Whether the user is currently paused in this pool"},"currentProgress":{"description":"The user's current training progress","$ref":"#/components/schemas/InterviewerPoolTrainingProgress"}},"required":["id","firstName","lastName","email","globalRole","isEnabled","updatedAt","isPaused","currentProgress"],"additionalProperties":false},"InterviewerPool":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The pool's id"},"title":{"type":"string","description":"The pool's title"},"isArchived":{"type":"boolean","description":"Whether the pool is archived"},"trainingPath":{"anyOf":[{"$ref":"#/components/schemas/InterviewerPoolTrainingPath"},{"type":"null"}],"description":"The training path for the interviewer pool"},"qualifiedMembers":{"description":"Qualified members of the interviewer pool","type":"array","items":{"$ref":"#/components/schemas/InterviewerPoolMember"}},"trainees":{"description":"Trainees in the interviewer pool","type":"array","items":{"$ref":"#/components/schemas/InterviewerPoolTrainingUser"}}},"required":["id","title","isArchived","trainingPath"],"additionalProperties":false},"InterviewerPoolCreateRequest":{"type":"object","properties":{"title":{"type":"string","description":"The title of the interviewer pool","example":"Engineering"},"requiresTraining":{"description":"Whether the interviewer pool requires training","example":true,"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["title"],"additionalProperties":false},"InterviewerPoolCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPool"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"InterviewerPoolRemoveUserRequest":{"type":"object","properties":{"interviewerPoolId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interviewer pool","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to remove from the interviewer pool","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPoolId","userId"],"additionalProperties":false},"InterviewerPoolRemoveUserSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPool"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"InterviewerPoolListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only interviewer pools updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of interviewer pools to return per page.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]},"includeArchivedPools":{"description":"When true, includes archived pools. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]},"includeArchivedTrainingStages":{"description":"When true, includes archived training stages. Defaults to true.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},"InterviewerPoolListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The pool's id"},"title":{"type":"string","description":"The pool's title"},"isArchived":{"type":"boolean","description":"Whether the pool is archived"},"trainingPath":{"anyOf":[{"$ref":"#/components/schemas/InterviewerPoolTrainingPath"},{"type":"null"}],"description":"The training path for the interviewer pool"}},"required":["id","title","isArchived","trainingPath"],"additionalProperties":false}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"InterviewerPoolInfoRequest":{"type":"object","properties":{"interviewerPoolId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interviewer pool","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPoolId"],"additionalProperties":false},"InterviewerPoolInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPool"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"InterviewerPoolArchiveRequest":{"type":"object","properties":{"interviewerPoolId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interviewer pool to archive","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPoolId"],"additionalProperties":false},"InterviewerPoolArchiveSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPool"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"InterviewerPoolRestoreRequest":{"type":"object","properties":{"interviewerPoolId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interviewer pool to restore","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPoolId"],"additionalProperties":false},"InterviewerPoolRestoreSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPool"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"InterviewerPoolUpdateRequest":{"type":"object","properties":{"interviewerPoolId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interviewer pool to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"description":"The title of the interviewer pool","example":"Engineering","anyOf":[{"type":"string"},{"type":"null"}]},"requiresTraining":{"description":"Whether the interviewer pool requires training","example":true,"anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["interviewerPoolId"],"additionalProperties":false},"InterviewerPoolUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPool"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"InterviewerPoolAddUserRequest":{"type":"object","properties":{"interviewerPoolId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interviewer pool","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to add to the interviewer pool","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewerPoolTrainingPathStageId":{"description":"The id of the training path stage to add the user to. If this is not provided, the user will be added as a fully qualified member of the pool.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["interviewerPoolId","userId"],"additionalProperties":false},"InterviewerPoolAddUserSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPool"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"2d8bb563-9ca2-47cd-a41c-d82dc0688508","title":"Zod Create QA 2026-04-24 0035","isArchived":false,"trainingPath":{"id":"99a059b6-121b-4e91-877d-720d4a12585a","enabled":true,"trainingStages":[{"id":"8182b3d8-e224-4c4f-8827-ed96cd860878","interviewerRole":"Shadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null},{"id":"037b5ae3-8901-4380-99f7-ac403d494d7f","interviewerRole":"ReverseShadow","interviewsRequired":1,"isArchived":false,"approvalRequired":false,"approvers":null}]}}}},"JobBoard":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The job board's unique identifier"},"title":{"type":"string","description":"The title of the job board"},"isInternal":{"type":"boolean","description":"Whether the job board is an internal board."}},"required":["id","title","isInternal"],"additionalProperties":false},"JobBoardListRequest":{"type":"object","properties":{},"additionalProperties":false},"JobBoardListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/JobBoard"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"ce033f37-9f24-4f6d-8b7f-1d8a3d7c0a2b","title":"Acme Careers","isInternal":false}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"JobInterviewPlanActivity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the activity"},"title":{"description":"The title of the activity, if any","anyOf":[{"type":"string"},{"type":"null"}]},"interviews":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the activity interview"},"title":{"type":"string","description":"The title of the interview to be scheduled"},"interviewId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview to be scheduled"},"interviewDurationMinutes":{"type":"number","description":"The duration of the interview, in minutes"},"isSchedulable":{"type":"boolean","description":"Whether the interview can be scheduled"}},"required":["id","title","interviewId","interviewDurationMinutes","isSchedulable"],"additionalProperties":false},"description":"The interviews to be scheduled by this activity"}},"required":["id","interviews"],"additionalProperties":false},"BaseInterviewStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview stage"},"title":{"type":"string","description":"The title of the interview stage"},"type":{"type":"string","description":"The type of the interview stage (e.g. Lead, PreInterviewScreen, Active, Offer, Archived, Hired)"},"orderInInterviewPlan":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The order of this stage within its interview plan (zero-indexed)"},"interviewStageGroupId":{"description":"The id of the interview stage group this stage belongs to, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","title","type","orderInInterviewPlan"],"additionalProperties":false},"JobInterviewPlan":{"type":"object","properties":{"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job this interview plan belongs to"},"interviewPlanId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interview plan"},"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the interview stage"},"title":{"type":"string","description":"The title of the interview stage"},"type":{"type":"string","description":"The type of the interview stage (e.g. Lead, PreInterviewScreen, Active, Offer, Archived, Hired)"},"orderInInterviewPlan":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The order of this stage within its interview plan (zero-indexed)"},"interviewStageGroupId":{"description":"The id of the interview stage group this stage belongs to, if any","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"activities":{"type":"array","items":{"$ref":"#/components/schemas/JobInterviewPlanActivity"},"description":"Activities to perform at this stage"}},"required":["id","title","type","orderInInterviewPlan","activities"],"additionalProperties":false},"description":"The stages that make up the interview plan, in plan order"}},"required":["jobId","interviewPlanId","stages"],"additionalProperties":false},"JobInterviewPlanInfoRequest":{"type":"object","properties":{"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job to fetch an interview plan for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["jobId"],"additionalProperties":false},"JobInterviewPlanInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/JobInterviewPlan"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"jobId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","interviewPlanId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","stages":[{"id":"8d4f4ef3-1b59-4f8b-bd23-69d4e2dc8af8","title":"Recruiter Phone Screen","type":"Active","orderInInterviewPlan":4,"activities":[{"id":"f1c1b9b7-bf95-4f2a-bbf4-2c7d3b8e1aaa","title":"Interview stage template","interviews":[{"id":"9bcec74e-2c1a-4ad1-8cda-f5b9a4f12bb2","title":"Recruiter Phone Call","interviewId":"f44eecb7-7a73-4cf4-a3ba-1f8da9d2d8e1","interviewDurationMinutes":60,"isSchedulable":true}]}]}]}}},"SurveyFormDefinition":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the survey form definition"},"title":{"type":"string","description":"The title of the survey form definition"},"isArchived":{"type":"boolean","description":"Whether the survey form definition is archived"},"formDefinition":{"description":"The form schema for this survey","$ref":"#/components/schemas/FormDefinition"},"surveyType":{"type":"string","enum":["EEOC","Diversity","CandidateExperience","CandidateDataConsent","Questionnaire","QualityOfHire","HiringManagerExperience"],"description":"The type of survey"}},"required":["id","title","isArchived","formDefinition","surveyType"],"additionalProperties":false},"SurveyFormDefinitionInfoRequest":{"type":"object","properties":{"surveyFormDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier of the survey form definition to fetch","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["surveyFormDefinitionId"],"additionalProperties":false},"SurveyFormDefinitionListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only survey form definitions updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of survey form definitions to return per page.","example":25,"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]}},"additionalProperties":false},"SurveyFormDefinitionInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SurveyFormDefinition"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"49e621fa-b342-413a-b876-5d924689c23b","title":"Example Candidate Experience Survey","isArchived":false,"formDefinition":{"sections":[{"fields":[{"isRequired":false,"field":{"id":"cb539763-33a2-4172-a915-dc14d9120671","type":"NPSRating","path":"_systemfield_overall_candexp_rating","humanReadablePath":"","title":"How likely are you to recommend us to others?","isNullable":false}}]}]},"surveyType":"CandidateExperience"}}},"SurveyFormDefinitionListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/SurveyFormDefinition"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"49e621fa-b342-413a-b876-5d924689c23b","title":"Example Candidate Experience Survey","isArchived":false,"formDefinition":{"sections":[{"fields":[{"isRequired":false,"field":{"id":"cb539763-33a2-4172-a915-dc14d9120671","type":"NPSRating","path":"_systemfield_overall_candexp_rating","humanReadablePath":"","title":"How likely are you to recommend us to others?","isNullable":false}}]}]},"surveyType":"CandidateExperience"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"JobPostingDescriptionPart":{"type":"object","properties":{"html":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An HTML version of this description part"},"plain":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A plaintext version of this description part"}},"required":["html","plain"],"additionalProperties":false},"JobPostingDescriptionParts":{"type":"object","properties":{"descriptionOpening":{"anyOf":[{"$ref":"#/components/schemas/JobPostingDescriptionPart"},{"type":"null"}],"description":"The content set in the Job Post Description Opening theme settings"},"descriptionBody":{"description":"The description set on the job posting","$ref":"#/components/schemas/JobPostingDescriptionPart"},"descriptionClosing":{"anyOf":[{"$ref":"#/components/schemas/JobPostingDescriptionPart"},{"type":"null"}],"description":"The content set in the Job Post Description Closing theme settings"}},"required":["descriptionOpening","descriptionBody","descriptionClosing"],"additionalProperties":false},"JobPostingLocationIds":{"type":"object","properties":{"primaryLocationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The primary location id for the job posting"},"secondaryLocationIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":"The secondary location ids for the job posting"}},"required":["primaryLocationId","secondaryLocationIds"],"additionalProperties":false},"JobPostingCompensationComponent":{"type":"object","properties":{"summary":{"type":"string","description":"A human-readable summary of the compensation component"},"label":{"description":"A human-readable label for the compensation component","anyOf":[{"type":"string"},{"type":"null"}]},"compensationType":{"type":"string","description":"The type of compensation"},"interval":{"type":"string","description":"The compensation interval"},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO currency code for monetary compensation"},"minValue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The minimum value for the compensation component"},"maxValue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The maximum value for the compensation component"}},"required":["summary","compensationType","interval","currencyCode","minValue","maxValue"],"additionalProperties":false},"JobPostingCompensationTier":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the compensation tier"},"tierSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A human-readable summary of the compensation tier"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The compensation tier title"},"additionalInformation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Additional information about the compensation tier"},"components":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","description":"A human-readable summary of the compensation component"},"label":{"description":"A human-readable label for the compensation component","anyOf":[{"type":"string"},{"type":"null"}]},"compensationType":{"type":"string","description":"The type of compensation"},"interval":{"type":"string","description":"The compensation interval"},"currencyCode":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ISO currency code for monetary compensation"},"minValue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The minimum value for the compensation component"},"maxValue":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The maximum value for the compensation component"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The component id"}},"required":["summary","compensationType","interval","currencyCode","minValue","maxValue","id"],"additionalProperties":false},"description":"The compensation components in this tier"}},"required":["id","tierSummary","title","additionalInformation","components"],"additionalProperties":false},"JobPostingCompensation":{"type":"object","properties":{"compensationTierSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A summary of all valid compensation tiers for the job posting"},"summaryComponents":{"type":"array","items":{"$ref":"#/components/schemas/JobPostingCompensationComponent"},"description":"The summary compensation components for the job posting"},"compensationTiers":{"type":"array","items":{"$ref":"#/components/schemas/JobPostingCompensationTier"},"description":"The compensation ranges that can be offered to applicants for this posting"},"shouldDisplayCompensation":{"type":"boolean","description":"Whether compensation should be shown to applicants for this job posting"}},"required":["compensationTierSummary","summaryComponents","compensationTiers","shouldDisplayCompensation"],"additionalProperties":false},"JobPostingBrief":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The job posting's id"},"title":{"type":"string","description":"The job posting's title"},"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job associated with the job posting"},"departmentName":{"type":"string","description":"The name of the department associated with the job posting"},"teamName":{"type":"string","description":"The name of the team associated with the job posting. `teamName` and `departmentName` will be the same if the team does not have a parent team specified."},"locationName":{"type":"string","description":"The name of the primary location associated with the job posting"},"locationIds":{"description":"The location ids associated with the job posting","$ref":"#/components/schemas/JobPostingLocationIds"},"workplaceType":{"description":"The type of workplace","anyOf":[{"type":"string","enum":["OnSite","Hybrid","Remote"]},{"type":"null"}]},"employmentType":{"type":"string","description":"The employment type for the job posting"},"isListed":{"type":"boolean","description":"Whether or not the job posting is listed"},"publishedDate":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The date the job posting was published. Null for unpublished (draft) job postings."},"applicationDeadline":{"description":"The date and time when applications will no longer be accepted","anyOf":[{"type":"string"},{"type":"null"}]},"externalLink":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"The external link to the job posting. Will be null if the job posting is on an internal job board."},"applyLink":{"type":"string","format":"uri","description":"The link to apply to the job posting. Will be to the public job board if the job posting is on an external job board, or to the internal job board if the job posting is on an internal job board."},"compensationTierSummary":{"description":"A summary of *all* the job posting's valid compensation tiers in the same format shown on Ashby-hosted Job Boards","anyOf":[{"type":"string"},{"type":"null"}]},"shouldDisplayCompensationOnJobBoard":{"type":"boolean","description":"Whether the job posting's settings specify that compensation should be shown to applicants when the posting is listed among other job postings"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the job posting was last updated"}},"required":["id","title","jobId","departmentName","teamName","locationName","locationIds","employmentType","isListed","publishedDate","externalLink","applyLink","shouldDisplayCompensationOnJobBoard","updatedAt"],"additionalProperties":false},"JobPostingLinkedData":{"type":"object","properties":{"@context":{"type":"string","description":"The JSON-LD context"},"@type":{"type":"string","description":"The JSON-LD type"},"title":{"type":"string","description":"The job posting's title"},"description":{"type":"string","description":"The job posting's description"},"datePosted":{"type":"string","description":"The date the job posting was published"},"employmentType":{"type":"string","description":"The employment type for the job posting"},"hiringOrganization":{"type":"object","properties":{"@type":{"type":"string"},"name":{"type":"string"},"sameAs":{"type":"string"}},"additionalProperties":{},"description":"The organization hiring for the job posting"},"identifier":{"type":"object","properties":{"@type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":{},"description":"The job posting's identifier"},"jobLocation":{"type":"object","properties":{"@type":{"type":"string"},"address":{"type":"object","properties":{"@type":{"type":"string"}},"additionalProperties":{}}},"additionalProperties":{},"description":"The location of the job posting"}},"additionalProperties":{}},"JobPostingAddress":{"type":"object","properties":{"postalAddress":{"type":"object","properties":{"addressCountry":{"type":"string"},"addressRegion":{"type":"string"},"addressLocality":{"type":"string"},"postalCode":{"type":"string"},"streetAddress":{"type":"string"}},"additionalProperties":{},"description":"The postal address of the job posting"}},"additionalProperties":{}},"JobPosting":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The job posting's id"},"title":{"type":"string","description":"The job posting's title"},"descriptionPlain":{"type":"string","description":"A plaintext version of the job posting's description"},"descriptionHtml":{"type":"string","description":"An HTML version of the job posting's description"},"descriptionSocial":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A shortened job posting description displayed when shared on social media"},"descriptionParts":{"description":"The job posting description broken down into opening, body, and closing sections","$ref":"#/components/schemas/JobPostingDescriptionParts"},"departmentName":{"type":"string","description":"The name of the department associated with the job posting"},"teamName":{"type":"string","description":"The name of the team associated with the job posting"},"teamNameHierarchy":{"type":"array","items":{"type":"string"},"description":"The hierarchy of team names associated with the job posting"},"jobId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job associated with the job posting"},"locationName":{"type":"string","description":"The name of the primary location associated with the job posting"},"locationAddress":{"description":"The address of the primary location associated with the job posting","anyOf":[{"type":"string"},{"type":"null"}]},"locationIds":{"description":"The location ids associated with the job posting","$ref":"#/components/schemas/JobPostingLocationIds"},"linkedData":{"description":"Structured data that can be used to populate rich results in search engines","$ref":"#/components/schemas/JobPostingLinkedData"},"publishedDate":{"anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}],"description":"The date the job posting was published"},"applicationDeadline":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"The date and time when applications will no longer be accepted"},"address":{"description":"The address of the job posting","anyOf":[{"$ref":"#/components/schemas/JobPostingAddress"},{"type":"null"}]},"isRemote":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether or not the job posting location is remote"},"workplaceType":{"anyOf":[{"type":"string","enum":["OnSite","Hybrid","Remote"]},{"type":"null"}],"description":"The type of workplace"},"employmentType":{"type":"string","description":"The employment type for the job posting"},"applicationFormDefinition":{"description":"The application form definition for this job posting","$ref":"#/components/schemas/FormDefinition"},"surveyFormDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/SurveyFormDefinition"},"description":"Additional survey forms collected alongside the application form"},"isListed":{"type":"boolean","description":"Whether or not the job posting is listed"},"suppressDescriptionOpening":{"type":"boolean","description":"Whether the job description opening from the brand is suppressed"},"suppressDescriptionClosing":{"type":"boolean","description":"Whether the job description closing from the brand is suppressed"},"externalLink":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}],"description":"The external link to the job posting, or null for internal job boards"},"applyLink":{"type":"string","format":"uri","description":"The link to apply to the job posting"},"compensation":{"description":"Compensation ranges associated with the job posting and related settings","$ref":"#/components/schemas/JobPostingCompensation"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the job posting was last updated"},"applicationLimitCalloutHtml":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An HTML communication shown to applicants about application limits"},"job":{"description":"The expanded job associated with the job posting","anyOf":[{"type":"object","properties":{},"additionalProperties":{}},{"type":"null"}]}},"required":["id","title","descriptionPlain","descriptionHtml","descriptionSocial","descriptionParts","departmentName","teamName","teamNameHierarchy","jobId","locationName","locationIds","linkedData","publishedDate","applicationDeadline","isRemote","workplaceType","employmentType","applicationFormDefinition","surveyFormDefinitions","isListed","suppressDescriptionOpening","suppressDescriptionClosing","externalLink","applyLink","compensation","updatedAt","applicationLimitCalloutHtml"],"additionalProperties":false},"JobPostingInfoRequest":{"type":"object","properties":{"jobPostingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the job posting to return","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobBoardId":{"description":"If provided, returns the job posting data for the specified job board. If omitted, defaults to an external job board.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"includeUnpublishedJobPostings":{"description":"If true, allows retrieving unpublished (draft) job postings. Required when fetching a draft job posting.","anyOf":[{"type":"boolean"},{"type":"null"}]},"expand":{"description":"Choose to expand the result and include additional data for related objects.","anyOf":[{"type":"array","items":{"type":"string","enum":["job"]}},{"type":"null"}]}},"required":["jobPostingId"],"additionalProperties":false},"JobPostingListRequest":{"type":"object","properties":{"location":{"description":"Filter by location name (case sensitive)","anyOf":[{"type":"string"},{"type":"null"}]},"department":{"description":"Filter by department name (case sensitive)","anyOf":[{"type":"string"},{"type":"null"}]},"listedOnly":{"description":"If true, filter out unlisted job postings.","anyOf":[{"type":"boolean"},{"type":"null"}]},"includeUnpublishedJobPostings":{"description":"If true, include unpublished (draft) job postings in addition to published job postings.","anyOf":[{"type":"boolean"},{"type":"null"}]},"jobBoardId":{"description":"If provided, only returns the job postings on the specified job board. If omitted, this API will return the job postings on the primary external job board.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"additionalProperties":false},"JobPostingUpdateRequest":{"type":"object","properties":{"jobPostingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the job posting to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"description":"A new title for the job posting","example":"Software Engineer","anyOf":[{"type":"string"},{"type":"null"}]},"workplaceType":{"description":"The type of workplace","anyOf":[{"type":"string","enum":["OnSite","Hybrid","Remote"]},{"type":"null"}]},"suppressDescriptionOpening":{"description":"When true, the job description opening from the brand will be suppressed. descriptionOpening will be returned as null.","example":true,"anyOf":[{"type":"boolean"},{"type":"null"}]},"suppressDescriptionClosing":{"description":"When true, the job description closing from the brand will be suppressed. descriptionClosing will be returned as null.","example":true,"anyOf":[{"type":"boolean"},{"type":"null"}]},"description":{"description":"An HTML block of the job posting description","anyOf":[{"type":"object","properties":{"type":{"type":"string","const":"text/html","description":"The content type of the job posting description"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The HTML content of the job posting description"}},"required":["type","value"],"additionalProperties":false},{"type":"null"}]},"includeUnpublishedJobPostings":{"description":"When true, allows updating unpublished (draft) job postings. Required when updating a draft posting.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["jobPostingId"],"additionalProperties":false},"JobPostingUpdateCompensationRequest":{"type":"object","properties":{"jobPostingId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the job posting to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"compensationTiers":{"anyOf":[{"minItems":1,"type":"array","items":{"type":"object","properties":{"title":{"description":"A label that describes the entire range to applicants. Required when more than one tier is provided.","example":"Zone A","anyOf":[{"type":"string"},{"type":"null"}]},"additionalInformation":{"description":"Supplementary information about the compensation","example":"Signing bonus available","anyOf":[{"type":"string"},{"type":"null"}]},"components":{"type":"array","items":{"type":"object","properties":{"compensationType":{"type":"string","enum":["Salary","EquityPercentage","EquityCashValue","Bonus","Commission"],"description":"The type of compensation this component represents","example":"Salary"},"interval":{"type":"string","enum":["NONE","1 TIME","1 HOUR","1 DAY","1 WEEK","2 WEEK","1 MONTH","2 MONTH","1 YEAR","6 MONTH","0.5 MONTH","3 MONTH"],"description":"The frequency at which this compensation is given","example":"1 YEAR"},"label":{"description":"An optional label that describes this compensation range to applicants","anyOf":[{"type":"string"},{"type":"null"}]},"currencyCode":{"description":"For non `EquityPercentage` components, the ISO 4217 currency code of the compensation range","example":"EUR","anyOf":[{"type":"string"},{"type":"null"}]},"minValue":{"description":"The lower end of the compensation range","example":72023.45,"anyOf":[{"type":"number"},{"type":"null"}]},"maxValue":{"description":"The higher end of the compensation range","example":100000,"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["compensationType","interval"],"additionalProperties":false},"description":"The individual components that make up this compensation range"}},"required":["components"],"additionalProperties":false}},{"type":"null"}],"description":"The compensation tiers to set on the job posting. Pass `null` to reset the posting to inherit compensation from the parent job."},"includeUnpublishedJobPostings":{"description":"When true, allows updating compensation for unpublished (draft) job postings. Required when updating a draft posting.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["jobPostingId","compensationTiers"],"additionalProperties":false},"JobPostingUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/JobPosting"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","descriptionPlain":"This role will build and maintain customer-facing software.","descriptionHtml":"<p>This role will build and maintain customer-facing software.</p>","descriptionSocial":null,"descriptionParts":{"descriptionOpening":null,"descriptionBody":{"html":"<p>This role will build and maintain customer-facing software.</p>","plain":"This role will build and maintain customer-facing software."},"descriptionClosing":null},"departmentName":"Engineering","teamName":"Product Engineering","teamNameHierarchy":["Engineering","Product Engineering"],"jobId":"8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d","locationName":"San Francisco","locationAddress":"San Francisco, California, United States","locationIds":{"primaryLocationId":"7bb8f10f-12d0-4d26-8d08-0f432a67b123","secondaryLocationIds":[]},"linkedData":{},"publishedDate":"2024-01-15","applicationDeadline":null,"address":{"postalAddress":{"addressRegion":"California","addressCountry":"United States","addressLocality":"San Francisco"}},"isRemote":false,"workplaceType":"OnSite","employmentType":"FullTime","applicationFormDefinition":{},"surveyFormDefinitions":[],"isListed":true,"suppressDescriptionOpening":false,"suppressDescriptionClosing":false,"externalLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applyLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","compensation":{"compensationTierSummary":"$100K - $120K","summaryComponents":[{"summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}],"compensationTiers":[{"id":"7acaf4b2-fbd2-47f9-8d09-222a3a469da1","tierSummary":"$100K - $120K","title":null,"additionalInformation":null,"components":[{"id":"e58d5b1e-6fc7-4df4-a418-e4f746235db7","summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}]}],"shouldDisplayCompensation":true},"updatedAt":"2024-01-15T10:30:00.000Z","applicationLimitCalloutHtml":null}}},"JobPostingUpdateCompensationSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/JobPosting"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","descriptionPlain":"This role will build and maintain customer-facing software.","descriptionHtml":"<p>This role will build and maintain customer-facing software.</p>","descriptionSocial":null,"descriptionParts":{"descriptionOpening":null,"descriptionBody":{"html":"<p>This role will build and maintain customer-facing software.</p>","plain":"This role will build and maintain customer-facing software."},"descriptionClosing":null},"departmentName":"Engineering","teamName":"Product Engineering","teamNameHierarchy":["Engineering","Product Engineering"],"jobId":"8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d","locationName":"San Francisco","locationAddress":"San Francisco, California, United States","locationIds":{"primaryLocationId":"7bb8f10f-12d0-4d26-8d08-0f432a67b123","secondaryLocationIds":[]},"linkedData":{},"publishedDate":"2024-01-15","applicationDeadline":null,"address":{"postalAddress":{"addressRegion":"California","addressCountry":"United States","addressLocality":"San Francisco"}},"isRemote":false,"workplaceType":"OnSite","employmentType":"FullTime","applicationFormDefinition":{},"surveyFormDefinitions":[],"isListed":true,"suppressDescriptionOpening":false,"suppressDescriptionClosing":false,"externalLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applyLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","compensation":{"compensationTierSummary":"$100K - $120K","summaryComponents":[{"summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}],"compensationTiers":[{"id":"7acaf4b2-fbd2-47f9-8d09-222a3a469da1","tierSummary":"$100K - $120K","title":null,"additionalInformation":null,"components":[{"id":"e58d5b1e-6fc7-4df4-a418-e4f746235db7","summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}]}],"shouldDisplayCompensation":true},"updatedAt":"2024-01-15T10:30:00.000Z","applicationLimitCalloutHtml":null}}},"JobPostingInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/JobPosting"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","descriptionPlain":"This role will build and maintain customer-facing software.","descriptionHtml":"<p>This role will build and maintain customer-facing software.</p>","descriptionSocial":null,"descriptionParts":{"descriptionOpening":null,"descriptionBody":{"html":"<p>This role will build and maintain customer-facing software.</p>","plain":"This role will build and maintain customer-facing software."},"descriptionClosing":null},"departmentName":"Engineering","teamName":"Product Engineering","teamNameHierarchy":["Engineering","Product Engineering"],"jobId":"8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d","locationName":"San Francisco","locationAddress":"San Francisco, California, United States","locationIds":{"primaryLocationId":"7bb8f10f-12d0-4d26-8d08-0f432a67b123","secondaryLocationIds":[]},"linkedData":{},"publishedDate":"2024-01-15","applicationDeadline":null,"address":{"postalAddress":{"addressRegion":"California","addressCountry":"United States","addressLocality":"San Francisco"}},"isRemote":false,"workplaceType":"OnSite","employmentType":"FullTime","applicationFormDefinition":{},"surveyFormDefinitions":[],"isListed":true,"suppressDescriptionOpening":false,"suppressDescriptionClosing":false,"externalLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applyLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","compensation":{"compensationTierSummary":"$100K - $120K","summaryComponents":[{"summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}],"compensationTiers":[{"id":"7acaf4b2-fbd2-47f9-8d09-222a3a469da1","tierSummary":"$100K - $120K","title":null,"additionalInformation":null,"components":[{"id":"e58d5b1e-6fc7-4df4-a418-e4f746235db7","summary":"$100K - $120K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"USD","minValue":100000,"maxValue":120000}]}],"shouldDisplayCompensation":true},"updatedAt":"2024-01-15T10:30:00.000Z","applicationLimitCalloutHtml":null}}},"JobPostingListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/JobPostingBrief"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","jobId":"8cfb4f68-4d1f-4f8b-9b2f-1f3f2c945f3d","departmentName":"Engineering","teamName":"Product Engineering","locationName":"San Francisco","locationIds":{"primaryLocationId":"7bb8f10f-12d0-4d26-8d08-0f432a67b123","secondaryLocationIds":[]},"workplaceType":"OnSite","employmentType":"FullTime","isListed":true,"publishedDate":"2024-01-15","applicationDeadline":null,"externalLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applyLink":"https://jobs.ashbyhq.com/example/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","compensationTierSummary":"$100K - $120K","shouldDisplayCompensationOnJobBoard":true,"updatedAt":"2024-01-15T10:30:00.000Z"}]}},"JobTemplateStatus":{"type":"string","enum":["Active","Inactive"]},"JobTemplate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The job template's unique identifier"},"title":{"type":"string","description":"The title of the job template"},"status":{"description":"The status of the job template","$ref":"#/components/schemas/JobTemplateStatus"},"locationId":{"description":"The id of the location of the job template","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"departmentId":{"description":"The id of the department or team associated with the job template","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"defaultInterviewPlanId":{"description":"The id of the default interview plan for this job template. A job cannot be opened without a default interview plan.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"interviewPlanIds":{"description":"The ids of all interview plans associated with the job template","type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"location":{"description":"The location for this job template. Only included when the `location` expand parameter is provided, and may be `null` when the job template has no location.","anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the job template was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the job template was last updated"}},"required":["id","title","status","createdAt","updatedAt"],"additionalProperties":false},"JobTemplateListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of job templates to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only job templates updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"expand":{"description":"Expand the result with related objects. Supported values are `location`.","anyOf":[{"type":"array","items":{"type":"string","enum":["location"]}},{"type":"null"}]}},"additionalProperties":false},"JobTemplateListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/JobTemplate"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Software Engineer","status":"Active","locationId":"b9b9b9b9-b9b9-4b9b-b9b9-b9b9b9b9b9b9","departmentId":"c8c8c8c8-c8c8-4c8c-c8c8-c8c8c8c8c8c8","defaultInterviewPlanId":"d7d7d7d7-d7d7-4d7d-d7d7-d7d7d7d7d7d7","interviewPlanIds":["d7d7d7d7-d7d7-4d7d-d7d7-d7d7d7d7d7d7"],"createdAt":"2022-08-12T20:29:56.964Z","updatedAt":"2023-09-13T21:30:57.965Z"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"Participant":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the participant. For interviewers, this is the Ashby user id. For candidates, this is the candidate id."},"type":{"type":"string","enum":["interviewer","candidate"],"description":"Whether this participant is an interviewer or the candidate"},"name":{"type":"string","description":"The display name of the participant"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The primary email address of the participant, or null if not available"}},"required":["id","type","name","email"],"additionalProperties":false},"NotetakerTranscript":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the notetaker transcript recording"},"interviewEventId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The id of the interview event this transcript is associated with"},"interviewScheduleId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The id of the interview schedule this transcript is associated with"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The time the transcript recording was created"},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Participant"},"description":"The participants in the interview, resolved from the interview schedule. Includes interviewers and the candidate."},"transcriptUrl":{"type":"string","description":"A signed URL to download the transcript JSON. The URL expires after 5 minutes. Download promptly after receiving the response. If the URL has expired, call the endpoint again to get a fresh one."}},"required":["id","interviewEventId","interviewScheduleId","createdAt","participants","transcriptUrl"],"additionalProperties":false},"NotetakerTranscriptInfoRequest":{"type":"object","properties":{"notetakerTranscriptId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the notetaker transcript to fetch","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["notetakerTranscriptId"],"additionalProperties":false},"NotetakerTranscriptInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/NotetakerTranscript"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","interviewEventId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","interviewScheduleId":"a0bbb968-e31d-4e23-800a-2f75ed4ec107","createdAt":"2026-04-25T02:46:41.817Z","participants":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","type":"interviewer","name":"Jane Smith","email":"jane.smith@example.com"},{"id":"7211e226-7802-41fd-8d55-2720fe9d534f","type":"candidate","name":"John Doe","email":"john.doe@example.com"}],"transcriptUrl":"https://s3.amazonaws.com/..."}}},"OfferAcceptanceStatus":{"type":"string","enum":["Accepted","Declined","Pending","Created","Cancelled"],"description":"The candidate's acceptance status for the offer"},"OfferProcessStatus":{"type":"string","enum":["WaitingOnOfferCreation","WaitingOnApprovalStart","WaitingOnOfferApproval","WaitingOnApprovalDefinition","WaitingOnCandidateResponse","CandidateRejected","CandidateAccepted","OfferCancelled"],"description":"The current status of the offer process"},"OfferVersionApprovalStatus":{"type":"string","enum":["Approved","WaitingOnApprovals","Declined"],"description":"The approval status of this offer version, if approvals are configured"},"OfferCurrencyNumericValue":{"type":"object","properties":{"value":{"type":"number","description":"The numeric currency amount"},"currencyCode":{"type":"string","description":"A valid ISO 4217 currency code"}},"required":["value","currencyCode"],"additionalProperties":false},"OfferFileHandle":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the file"},"name":{"type":"string","description":"The file name"},"handle":{"type":"string","description":"The file handle that can be used with the file.info endpoint"}},"required":["id","name","handle"],"additionalProperties":false},"OfferCustomField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the custom field"},"isPrivate":{"description":"Whether the custom field is private","anyOf":[{"type":"boolean"},{"type":"null"}]},"title":{"type":"string","description":"The custom field title"},"valueLabel":{"description":"The display label for select custom field values","anyOf":[{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},{"type":"null"}]},"value":{"anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/OfferCurrencyNumericValue"},{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"number"},{"type":"object","properties":{"type":{"type":"string","const":"number-range","description":"The custom field value type"},"minValue":{"type":"number","description":"The minimum value in the range"},"maxValue":{"type":"number","description":"The maximum value in the range"}},"required":["type","minValue","maxValue"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","const":"compensation-range","description":"The custom field value type"},"minValue":{"type":"number","description":"The minimum compensation value in the range"},"maxValue":{"type":"number","description":"The maximum compensation value in the range"},"currencyCode":{"type":"string","description":"A valid ISO 4217 currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":false}],"description":"The custom field value"}},"required":["id","title","value"],"additionalProperties":false},"OfferVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the offer version"},"startDate":{"description":"The start date of the offer","anyOf":[{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"},{"type":"null"}]},"salary":{"description":"The salary specified by the offer","anyOf":[{"$ref":"#/components/schemas/OfferCurrencyNumericValue"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The time the offer version was created"},"openingId":{"description":"The id of the opening associated with the offer","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"customFields":{"description":"Custom fields associated with the offer version","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/OfferCustomField"}},{"type":"null"}]},"fileHandles":{"description":"File handles associated with the offer version","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/OfferFileHandle"}},{"type":"null"}]},"author":{"description":"The user who authored the offer version","anyOf":[{"$ref":"#/components/schemas/User"},{"type":"null"}]},"approvalStatus":{"description":"The approval status of this offer version","anyOf":[{"$ref":"#/components/schemas/OfferVersionApprovalStatus"},{"type":"null"}]}},"required":["id","createdAt"],"additionalProperties":false},"Offer":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the offer"},"decidedAt":{"description":"The time the offer was accepted or rejected","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application associated with the offer"},"acceptanceStatus":{"$ref":"#/components/schemas/OfferAcceptanceStatus"},"offerStatus":{"$ref":"#/components/schemas/OfferProcessStatus"},"latestVersion":{"description":"The latest version of the offer","anyOf":[{"$ref":"#/components/schemas/OfferVersion"},{"type":"null"}]},"formDefinition":{"description":"The offer form definition. Omitted from the response when `excludeFormDefinition: true` is passed in the request.","$ref":"#/components/schemas/FormDefinition"},"versions":{"description":"The versions of the offer","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/OfferVersion"}},{"type":"null"}]}},"required":["id","applicationId","acceptanceStatus","offerStatus"],"additionalProperties":false},"OfferCreateRequest":{"type":"object","properties":{"offerProcessId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the offer process associated with the offer you're creating. This value is the id included in the response of the `offerProcess.start` API.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"offerFormId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the form associated with the offer. This value is the id included in the response of the `offer.start` API.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"offerForm":{"type":"object","properties":{"fieldSubmissions":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The form field's \"path\" value"},"value":{"description":"The submitted value for the form field. The accepted shape depends on the field's type (see the endpoint description for the full mapping).\n- Location field: An object with the following properties: `{ country: \"USA\", city: \"San Francisco\", region: \"California\" }`. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties."}},"required":["path","value"],"additionalProperties":{}},"description":"The list of field values to submit for the offer form"}},"required":["fieldSubmissions"],"additionalProperties":{},"description":"The offer form submission"},"excludeFormDefinition":{"description":"If true, omit the form definition from the response.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["offerProcessId","offerFormId","offerForm"],"additionalProperties":false},"OfferCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Offer"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnApprovalStart","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"OfferStartApprovalProcessRequest":{"type":"object","properties":{"offerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the offer version whose approval process should be started","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"note":{"description":"Optional note to attach to the approval request","anyOf":[{"type":"string"},{"type":"null"}]},"excludeFormDefinition":{"description":"If true, omit the form definition from the response.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["offerVersionId"],"additionalProperties":false},"OfferStartApprovalProcessSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Offer"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Created","offerStatus":"WaitingOnOfferApproval","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"OfferInfoRequest":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the offer to fetch","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"excludeFormDefinition":{"description":"If true, omit the form definition from the response.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["offerId"],"additionalProperties":false},"OfferInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Offer"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"OfferListRequest":{"type":"object","properties":{"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only offers updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]},"createdAfter":{"description":"The API will return data after this date, expressed as milliseconds since the Unix epoch.","anyOf":[{"type":"number"},{"type":"null"}]},"offerStatus":{"description":"When supplied, only offers with provided offer-status(es) will be returned. Array must contain at least one value.","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/OfferProcessStatus"}},{"type":"null"}]},"acceptanceStatus":{"description":"When supplied, only offers with provided acceptance-status(es) will be returned. Array must contain at least one value.","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/OfferAcceptanceStatus"}},{"type":"null"}]},"applicationId":{"description":"If provided, only returns the offers for the application with the supplied id","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"approvalStatus":{"description":"When supplied, only offers whose latest version has one of the provided approval status(es) will be returned. Array must contain at least one value.","anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/OfferVersionApprovalStatus"}},{"type":"null"}]}},"additionalProperties":false},"OfferListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"OfferStartRequest":{"type":"object","properties":{"offerProcessId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the offer process to start. This value is the id included in the response of the `offerProcess.start` API.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["offerProcessId"],"additionalProperties":false},"OfferStartResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the newly created offer form"},"formDefinition":{"description":"The offer form definition","$ref":"#/components/schemas/FormDefinition"}},"required":["id","formDefinition"],"additionalProperties":false},"OfferStartSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/OfferStartResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]}}}},"OfferUpdateRequest":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the offer you're updating.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"offerForm":{"type":"object","properties":{"fieldSubmissions":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The form field's \"path\" value"},"value":{"description":"The submitted value for the form field. The accepted shape depends on the field's type (see the endpoint description for the full mapping).\n- Location field: An object with the following properties: `{ country: \"USA\", city: \"San Francisco\", region: \"California\" }`. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties."}},"required":["path","value"],"additionalProperties":{}},"description":"The list of field values to submit for the offer form"}},"required":["fieldSubmissions"],"additionalProperties":{},"description":"The form submission for the offer. Can be retrieved from `offer.info`."},"excludeFormDefinition":{"description":"If true, omit the form definition from the response.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["offerId","offerForm"],"additionalProperties":false},"OfferUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Offer"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"OfferSetStatusAcceptanceStatus":{"type":"string","enum":["Accepted","Declined","Cancelled"],"description":"The offer acceptance status"},"OfferSetStatusRequest":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the offer whose status should be updated."},"acceptanceStatus":{"description":"The offer acceptance status. Ashby derives the offer status from this value.","$ref":"#/components/schemas/OfferSetStatusAcceptanceStatus"},"excludeFormDefinition":{"description":"If true, omit the form definition from the response.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["offerId","acceptanceStatus"],"additionalProperties":false},"OfferSetStatusSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Offer"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Accepted","offerStatus":"CandidateAccepted","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"OfferSetDecidedAtRequest":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the offer whose decided at timestamp should be updated."},"decidedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The time the offer was accepted or declined."},"excludeFormDefinition":{"description":"If true, omit the form definition from the response.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["offerId","decidedAt"],"additionalProperties":false},"OfferSetDecidedAtSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Offer"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":"2026-06-01T12:00:00.000Z","applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":null},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"OfferApproveRequest":{"type":"object","properties":{"offerVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the offer version that needs approval. This can be obtained as the `entityId` from the `approval.list` endpoint.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"approvalStepId":{"description":"The id of the specific approval step to approve. If provided, `userId` must also be provided. If omitted, the entire offer approval process will be approved. This can be obtained from the `approval.list` endpoint.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"userId":{"description":"The id of the user approving the step. Required if `approvalStepId` is provided. Must be an approver for the specified approval step.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"excludeFormDefinition":{"description":"If true, omit the form definition from the response.","anyOf":[{"type":"boolean"},{"type":"null"}]}},"required":["offerVersionId"],"additionalProperties":false},"OfferApproveSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Offer"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"8bd7d0d4-98bb-4bfa-8d42-13b2efd3ba88","decidedAt":null,"applicationId":"3d9539db-cd22-4f7f-a8f9-a9d5d1f364dd","acceptanceStatus":"Pending","offerStatus":"WaitingOnCandidateResponse","latestVersion":{"id":"698a9280-0a1d-4e72-acd0-b45c771363e8","startDate":"2026-05-01","salary":{"value":100000,"currencyCode":"USD"},"createdAt":"2026-04-25T02:07:01.594Z","openingId":"1bdb1c73-6ed5-4fc2-8486-16ce03a57c67","customFields":[],"fileHandles":[],"approvalStatus":"Approved"},"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"69c5aa80-34c1-4385-88ed-b2b2676e639d","type":"UUID","path":"opening.id","humanReadablePath":"Opening","title":"Opening","isNullable":false}}]}]},"versions":[]}}},"OfferProcess":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the started offer process"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application the offer process was started for"},"status":{"type":"string","enum":["WaitingOnOfferCreation","WaitingOnApprovalStart","WaitingOnOfferApproval","WaitingOnApprovalDefinition","WaitingOnCandidateResponse","CandidateRejected","CandidateAccepted","OfferCancelled"],"description":"The status of the offer process"}},"required":["id","applicationId","status"],"additionalProperties":false},"OfferProcessStartRequest":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application to start an offer process for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["applicationId"],"additionalProperties":false},"OfferProcessStartSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/OfferProcess"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","status":"WaitingOnOfferCreation"}}},"ReferralFieldSubmission":{"type":"object","properties":{"path":{"type":"string","description":"The form field's \"path\" value"},"value":{"description":"The value depends on the field type:\n- Most fields: A primitive value (string, number, boolean)\n- Job field: An object with `{ title: job.title, value: job.id }`. The referenced job must be open.\n- Location field: An object with the following properties: `{ country: \"USA\", city: \"San Francisco\", region: \"California\" }`. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties.\n- EducationHistory field: [Early Access] An array of objects with the following properties: `{ schoolName: \"University of California, Berkeley\", degree: \"Bachelor of Science\", major: \"Computer Science\", startDate: \"2020-09-01\", endDate: \"2024-05-15\", isCurrent: true }`. Only `schoolName` is required. We will attempt to match the school name to a known school in our database. If `isCurrent` is true, `endDate` must not be provided."}},"required":["path","value"],"additionalProperties":false},"ReferralCreateRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the referral form, from /referralForm.info","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"creditedToUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user submitting the referral","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"fieldSubmissions":{"description":"The field submissions for the referral form","type":"array","items":{"$ref":"#/components/schemas/ReferralFieldSubmission"}},"createdAt":{"description":"An ISO date string to set the referral's createdAt timestamp to. When this value isn't provided, the createdAt timestamp defaults to the time the referral was created.","example":"2022-08-12T20:29:56.964Z","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["id","creditedToUserId","fieldSubmissions"],"additionalProperties":false},"ReferralCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Application"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","status":"Active","customFields":[],"candidate":{"id":"84bfbed7-ed0a-496d-bb18-11b73369f666","name":"Michael Bluth","primaryEmailAddress":{"value":"michael@bluth.example","type":"Personal","isPrimary":true},"primaryPhoneNumber":null},"currentInterviewStage":{"id":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","title":"Application Review","type":"PreInterviewScreen","orderInInterviewPlan":1,"interviewStageGroupId":null,"interviewPlanId":"d3f4762e-1234-4abc-9876-aabbccddeeff"},"source":null,"archiveReason":null,"archivedAt":null,"job":{"id":"4071538b-3cac-4fbf-ac76-f78ed250ffdd","title":"First Designer","locationId":null,"departmentId":null},"creditedToUser":{"id":"7211e226-7802-41fd-8d55-2720fe9d534f","firstName":"George","lastName":"Bluth","email":"george@bluth.example"},"hiringTeam":[],"appliedViaJobPostingId":null,"submitterClientIp":null,"submitterUserAgent":null}}},"ReferralFormDefinition":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the referral form"},"organizationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the organization this form belongs to"},"title":{"type":"string","description":"The title of the form"},"isArchived":{"type":"boolean","description":"Whether the form is archived"},"isDefaultForm":{"type":"boolean","description":"Whether this is the default referral form for the organization"},"formDefinition":{"description":"The form definition for this referral form","$ref":"#/components/schemas/FormDefinition"}},"required":["id","organizationId","title","isArchived","isDefaultForm","formDefinition"],"additionalProperties":false},"ReferralFormInfoRequest":{"type":"object","properties":{},"additionalProperties":false},"ReferralFormInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ReferralFormDefinition"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"ec0a6c43-c1f3-4d4e-92f9-9d9c7e6c8e8d","organizationId":"5d3b8d24-2f4f-4f3a-8f3a-6c4b7d2e5b1a","title":"Default Referral Form","isArchived":false,"isDefaultForm":true,"formDefinition":{"sections":[{"fields":[{"isRequired":true,"field":{"id":"5c5d9b9e-5b3a-4f5b-9b7c-7e9c8a2d3e4f","type":"String","path":"_systemfield_name","humanReadablePath":"Name","title":"Name","isNullable":false}},{"isRequired":true,"field":{"id":"a7b6c5d4-e3f2-4a1b-9c8d-7e6f5a4b3c2d","type":"Email","path":"_systemfield_email","humanReadablePath":"Email","title":"Email","isNullable":false}}]}]}}}},"ReportData":{"type":"object","properties":{"data":{"type":"array","items":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"description":"Report data rows as arrays of values. When includeHeadersInData is true (default), the first row contains column headers."},"columnNames":{"type":"array","items":{"type":"string"},"description":"Column names/headers for the report data."},"metadata":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the report data was last updated"},"title":{"type":"string","description":"Report title"},"reportGeneratedAt":{"description":"ISO 8601 timestamp indicating when the report data was generated. Only present when status is complete.","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"cacheExpiresAt":{"description":"ISO 8601 timestamp indicating when the cached report data will expire. Only present when status is complete or failed.","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["updatedAt","title"],"additionalProperties":false,"description":"Metadata describing the generated report data."}},"required":["data","columnNames","metadata"],"additionalProperties":false},"UrlReportData":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Presigned S3 URL to download the completed report data directly. The downloaded body is brotli-compressed JSON of the form `{ data, columnNames, metadata }` — the same shape as inline `reportData`, with column headers as the first row of `data`, except `metadata` carries only `updatedAt` and `title`. Clients must support brotli (Content-Encoding: br) decompression."},"metadata":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When the report data was last updated"},"title":{"type":"string","description":"Report title"},"reportGeneratedAt":{"description":"ISO 8601 timestamp indicating when the report data was generated. Only present when status is complete.","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"cacheExpiresAt":{"description":"ISO 8601 timestamp indicating when the cached report data will expire. Only present when status is complete or failed.","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]}},"required":["updatedAt","title"],"additionalProperties":false,"description":"Metadata describing the generated report data."}},"required":["url","metadata"],"additionalProperties":false},"ReportBuildStatus":{"type":"object","properties":{"requestId":{"type":"string","description":"Unique identifier for this report generation request"},"status":{"type":"string","enum":["requested","in_progress","complete","failed"],"description":"Current status of the report generation"},"reportData":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/ReportData"},{"$ref":"#/components/schemas/UrlReportData"}]},{"type":"null"}],"description":"Report data. Only present when status is complete. Contains inline `data`/`columnNames` when resultStyle is \"inline\" (the default, and the fallback for \"url\" when the cached result is in the legacy inline format), or `url` plus `metadata` when resultStyle is \"url\"."},"failureReason":{"description":"Error information if report generation failed.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["requestId","status","reportData"],"additionalProperties":false},"ReportGenerateRequest":{"type":"object","properties":{"reportId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the report","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"includeHeadersInData":{"description":"When true (default), column headers are included as the first row in the data array. When false, headers are only in the columnNames property.","anyOf":[{"type":"boolean"},{"type":"null"}]},"resultStyle":{"description":"How completed report data is returned. \"inline\" (default) embeds the data in the response; \"url\" returns a short-lived presigned S3 download URL instead. Requires includeHeadersInData to be true (or omitted) when \"url\".","anyOf":[{"type":"string","enum":["inline","url"]},{"type":"null"}]},"requestId":{"description":"Request ID for polling existing report generation status.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["reportId"],"additionalProperties":false},"ReportGenerateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ReportBuildStatus"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"requestId":"rep_result:12345abc","status":"complete","reportData":{"data":[["Timeframe","Department","Hired"],["Q1 2024","Engineering",45],["Q1 2024","Sales",32],["Q2 2024","Engineering",52]],"columnNames":["Timeframe","Department","Hired"],"metadata":{"updatedAt":"2024-01-15T10:30:00.000Z","title":"Quarterly Hiring Report","reportGeneratedAt":"2024-01-15T14:25:33.123Z","cacheExpiresAt":"2024-01-15T15:25:33.123Z"}},"failureReason":null}}},"ReportSynchronousRequest":{"type":"object","properties":{"reportId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the report","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"includeHeadersInData":{"description":"When true (default), column headers are included as the first row in the data array. When false, headers are only in the columnNames property.","anyOf":[{"type":"boolean"},{"type":"null"}]},"resultStyle":{"description":"How completed report data is returned. \"inline\" (default) embeds the data in the response; \"url\" returns a short-lived presigned S3 download URL instead. Requires includeHeadersInData to be true (or omitted) when \"url\".","anyOf":[{"type":"string","enum":["inline","url"]},{"type":"null"}]}},"required":["reportId"],"additionalProperties":false},"ReportSynchronousSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/ReportBuildStatus"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"requestId":"rep_result:12345abc","status":"complete","reportData":{"data":[["Timeframe","Department","Hired"],["Q1 2024","Engineering",45],["Q1 2024","Sales",32],["Q2 2024","Engineering",52]],"columnNames":["Timeframe","Department","Hired"],"metadata":{"updatedAt":"2024-01-15T10:30:00.000Z","title":"Quarterly Hiring Report","reportGeneratedAt":"2024-01-15T14:25:33.123Z","cacheExpiresAt":"2024-01-15T15:25:33.123Z"}},"failureReason":null}}},"SequenceStageType":{"type":"string","enum":["Email","InMail","LinkedInConnection"]},"SequenceSendAfter":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["NoDelay"]}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["AtDateAndTime"]},"dateTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"The absolute date and time when the stage is sent"},"timezone":{"type":"string","description":"The IANA timezone used for the scheduled date and time"}},"required":["kind","dateTime","timezone"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["TimeIntervalElapsed"]},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"description":"The number of delay units to wait after the previous stage"},"unit":{"type":"string","enum":["day","week","month","quarter","year"],"description":"The unit for the elapsed delay"},"time":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"The local send time in 24-hour HH:mm format"},"timezone":{"type":"string","description":"The IANA timezone used for the local send time"},"allowedWeekdays":{"type":"array","items":{"type":"integer","minimum":1,"maximum":7},"description":"Allowed send weekdays using ISO numbering, where Monday is 1 and Sunday is 7"}},"required":["kind","amount","unit","time","timezone","allowedWeekdays"],"additionalProperties":false}],"description":"The delay before this stage is sent"},"SequenceSender":{"type":"object","properties":{"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The address used to send this stage"},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The sender display name configured by Ashby, when one is available"}},"required":["email","displayName"],"additionalProperties":false},"SequenceStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for this sequence stage"},"type":{"description":"The communication channel used by the stage","$ref":"#/components/schemas/SequenceStageType"},"from":{"description":"The sender for an email stage. Omitted for non-email stages.","$ref":"#/components/schemas/SequenceSender"},"subject":{"description":"The resolved subject for an editable, not-started email stage","type":"string"},"bodyHtml":{"description":"The editable HTML body for a not-started email stage. Ashby token markers must be preserved when editing.","type":"string"},"sendAfter":{"$ref":"#/components/schemas/SequenceSendAfter"}},"required":["id","type","sendAfter"],"additionalProperties":false},"SequenceStatus":{"type":"string","enum":["NotStarted","Running","Paused","Completed","Cancelled","Unsubscribed"]},"Sequence":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for this candidate's sequence enrollment"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The candidate enrolled in the sequence"},"applicationId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The application selected for token resolution, when one is available"},"sequenceTemplateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The reusable sequence template used for enrollment"},"status":{"$ref":"#/components/schemas/SequenceStatus"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the sequence enrollment was created"},"stages":{"type":"array","items":{"$ref":"#/components/schemas/SequenceStage"},"description":"The stages in sequence order"}},"required":["id","candidateId","applicationId","sequenceTemplateId","status","createdAt","stages"],"additionalProperties":false},"SequenceLintIssue":{"type":"object","properties":{"type":{"type":"string","description":"The stable machine-readable issue type. Clients should tolerate types added in the future."}},"required":["type"],"additionalProperties":{},"description":"A structured sequence validation issue"},"SequenceLintResult":{"type":"object","properties":{"info":{"type":"array","items":{"type":"string"},"description":"Informational validation messages"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/SequenceLintIssue"},"description":"Non-blocking validation issues"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/SequenceLintIssue"},"description":"Validation issues that block starting"},"requiredActions":{"type":"array","items":{"$ref":"#/components/schemas/SequenceLintIssue"},"description":"Actions that must be completed before starting"}},"required":["info","warnings","errors","requiredActions"],"additionalProperties":false},"SequenceStartResult":{"type":"object","properties":{"status":{"type":"string","enum":["Started","Blocked"]},"lintResult":{"$ref":"#/components/schemas/SequenceLintResult"}},"required":["status","lintResult"],"additionalProperties":false},"SequenceAddRequest":{"type":"object","properties":{"sequenceTemplateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The reusable sourcing sequence template to use"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The candidate to enroll in the sequence"},"applicationId":{"description":"The candidate's application to use for token resolution","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"from":{"description":"The sending address to use for every email stage","type":"object","properties":{"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"A Primary, PersonalAlias, or OrganizationAlias address returned by emailSender.list for the same acting user. NoReply addresses are always rejected, including Ashby and custom-domain no-reply addresses."}},"required":["email"],"additionalProperties":false},"start":{"type":"boolean","description":"Whether to validate and start the sequence immediately after creating it"}},"required":["sequenceTemplateId","candidateId","start"],"additionalProperties":false},"SequenceAddResult":{"type":"object","properties":{"sequence":{"$ref":"#/components/schemas/Sequence"},"startResult":{"anyOf":[{"$ref":"#/components/schemas/SequenceStartResult"},{"type":"null"}],"description":"The start outcome, or null when the sequence was created as a draft"}},"required":["sequence","startResult"],"additionalProperties":false},"SequenceAddSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SequenceAddResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"sequence":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","candidateId":"26906e15-ff36-4ed3-b25b-de806d7852f7","applicationId":"71c2be26-cd82-4b9f-8e61-3ca2ed94c9a7","sequenceTemplateId":"97f36cec-3736-4f14-b1e2-ec60a132efab","status":"NotStarted","createdAt":"2026-07-22T12:34:56.000Z","stages":[{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","from":{"email":"gob@example.com","displayName":"Gob Bluth"},"subject":"A simple subject","bodyHtml":"<p>Hello</p>","sendAfter":{"kind":"NoDelay"}}]},"startResult":null}}},"SequenceInfoRequest":{"type":"object","properties":{"sequenceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the sequence enrollment"}},"required":["sequenceId"],"additionalProperties":false},"SequenceInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/Sequence"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","candidateId":"26906e15-ff36-4ed3-b25b-de806d7852f7","applicationId":"71c2be26-cd82-4b9f-8e61-3ca2ed94c9a7","sequenceTemplateId":"97f36cec-3736-4f14-b1e2-ec60a132efab","status":"NotStarted","createdAt":"2026-07-20T12:34:56.000Z","stages":[{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","from":{"email":"gob@example.com","displayName":"Gob Bluth"},"subject":"A simple subject","bodyHtml":"<p>Hello</p>","sendAfter":{"kind":"NoDelay"}}]}}},"SequenceDiscardRequest":{"type":"object","properties":{"sequenceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the draft sequence enrollment"}},"required":["sequenceId"],"additionalProperties":false},"SequenceDiscardResult":{"type":"object","properties":{"sequenceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the discarded sequence enrollment"}},"required":["sequenceId"],"additionalProperties":false},"SequenceDiscardSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SequenceDiscardResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"sequenceId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"SequenceUpdateStageRequest":{"type":"object","properties":{"sequenceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the sequence enrollment"},"stageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the email stage to update"},"subject":{"description":"A plain-text subject that replaces the stage's current subject","type":"string"},"bodyHtml":{"description":"HTML that replaces the stage's current body. Preserve Ashby token markers to keep their send-time values dynamic.","type":"string"}},"required":["sequenceId","stageId"],"additionalProperties":false},"SequenceUpdateStageSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SequenceStage"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","from":{"email":"gob@example.com","displayName":"Gob Bluth"},"subject":"A personalized subject","bodyHtml":"<p>Would you like to talk?</p>","sendAfter":{"kind":"NoDelay"}}}},"SequenceCancelRequest":{"type":"object","properties":{"sequenceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the sequence to cancel","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"reason":{"description":"The reason for cancelling the sequence. Defaults to `booked_meeting`.","type":"string","enum":["booked_meeting"]}},"required":["sequenceId"],"additionalProperties":false},"SequenceCancelResult":{"type":"object","properties":{"sequenceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the sequence that was cancelled","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["sequenceId"],"additionalProperties":false},"SequenceStartRequest":{"type":"object","properties":{"sequenceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the draft sequence enrollment"}},"required":["sequenceId"],"additionalProperties":false},"SequenceStartResponseResult":{"type":"object","properties":{"sequence":{"$ref":"#/components/schemas/Sequence"},"startResult":{"$ref":"#/components/schemas/SequenceStartResult"}},"required":["sequence","startResult"],"additionalProperties":false},"SequenceStartSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SequenceStartResponseResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"sequence":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","candidateId":"26906e15-ff36-4ed3-b25b-de806d7852f7","applicationId":"71c2be26-cd82-4b9f-8e61-3ca2ed94c9a7","sequenceTemplateId":"97f36cec-3736-4f14-b1e2-ec60a132efab","status":"Running","createdAt":"2026-07-23T12:34:56.000Z","stages":[{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","from":{"email":"gob@example.com","displayName":"Gob Bluth"},"sendAfter":{"kind":"NoDelay"}}]},"startResult":{"status":"Started","lintResult":{"info":[],"warnings":[],"errors":[],"requiredActions":[]}}}}},"SequenceCancelSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SequenceCancelResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"sequenceId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"SequenceTemplateStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the sequence template stage"},"type":{"description":"The communication channel used by the stage","$ref":"#/components/schemas/SequenceStageType"},"sendAfter":{"$ref":"#/components/schemas/SequenceSendAfter"}},"required":["id","type","sendAfter"],"additionalProperties":false},"SequenceTemplate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the sequence template"},"title":{"type":"string","description":"The sequence template's title"},"isArchived":{"type":"boolean","description":"Whether the sequence template is archived"},"unsubscribeLinkActive":{"type":"boolean","description":"Whether emails sent from the sequence include an unsubscribe link"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"When the returned template metadata last changed"},"stages":{"type":"array","items":{"$ref":"#/components/schemas/SequenceTemplateStage"},"description":"The template's stages in sequence order"}},"required":["id","title","isArchived","unsubscribeLinkActive","updatedAt","stages"],"additionalProperties":false},"SequenceTemplateInfoRequest":{"type":"object","properties":{"sequenceTemplateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the sequence template"}},"required":["sequenceTemplateId"],"additionalProperties":false},"SequenceTemplateListRequest":{"type":"object","properties":{"cursor":{"description":"Opaque cursor for the next page of results","type":"string"},"syncToken":{"description":"An opaque token representing the last completed synchronization. The final page returns a token for the next incremental synchronization.","type":"string"},"limit":{"description":"The maximum number of templates to return. Defaults to 100 and cannot exceed 100.","type":"integer","exclusiveMinimum":0,"maximum":100},"includeArchived":{"description":"Whether to include archived templates. Defaults to false.","type":"boolean"}},"additionalProperties":false},"SequenceTemplateInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SequenceTemplate"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"97f36cec-3736-4f14-b1e2-ec60a132efab","title":"Senior Engineer outreach","isArchived":false,"unsubscribeLinkActive":true,"updatedAt":"2026-07-13T12:34:56.000Z","stages":[{"id":"cc506f71-e2a3-438e-9130-a90b5f350ce3","type":"Email","sendAfter":{"kind":"NoDelay"}},{"id":"f03c715f-aa66-49ac-b983-04f51337760d","type":"Email","sendAfter":{"kind":"TimeIntervalElapsed","amount":3,"unit":"day","time":"09:00","timezone":"America/Los_Angeles","allowedWeekdays":[1,2,3,4,5]}}]}}},"SequenceTemplateListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/SequenceTemplate"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false},"SourceTrackingLink":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The tracking link's unique identifier"},"code":{"type":"string","description":"The tracking code appended to the link as a UTM source","example":"fx9iL4QtWr"},"enabled":{"type":"boolean","description":"Whether the tracking link is enabled"},"sourceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the source this tracking link is associated with"},"link":{"type":"string","description":"The fully-formed candidate-facing URL with the tracking code applied","example":"https://jobs.ashbyhq.com/example?utm_source=fx9iL4QtWr"}},"required":["id","code","enabled","sourceId","link"],"additionalProperties":false},"SourceTrackingLinkListRequest":{"type":"object","properties":{"includeDisabled":{"description":"When true, includes disabled tracking links. Defaults to false.","anyOf":[{"type":"boolean"},{"type":"null"}]},"sourceId":{"description":"Restrict the response to tracking links associated with this source id.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of tracking links to return per page. Maximum is 100.","example":25,"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only tracking links updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"SourceTrackingLinkListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/SourceTrackingLink"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f","code":"fx9iL4QtWr","enabled":true,"sourceId":"5be8b893-2c4b-4f6b-92d0-a37bd9d05ad7","link":"https://jobs.ashbyhq.com/example?utm_source=fx9iL4QtWr"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"SurveyRequest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the survey request","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"surveyUrl":{"type":"string","format":"uri","description":"The URL that the candidate can use to complete the survey"},"surveyFormDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the survey form definition","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the associated application","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the associated candidate","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","surveyUrl","surveyFormDefinitionId","applicationId","candidateId"],"additionalProperties":false},"SurveyRequestCreateRequest":{"type":"object","properties":{"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the candidate to create a survey request for.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the application to associate with the survey request.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"surveyFormDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The ID of the survey form that the candidate will see when they visit the URL returned in the `surveyURL` property of the API response. Survey forms IDs can be obtained using the `surveyFormDefinition.list` endpoint.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["candidateId","applicationId","surveyFormDefinitionId"],"additionalProperties":false},"SurveyRequestCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SurveyRequest"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyUrl":"https://example.ashbyhq.com/acme/survey/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyFormDefinitionId":"49e621fa-b342-413a-b876-5d924689c23b","applicationId":"38fdb18a-5753-48e0-8a55-d8a124c346b2","candidateId":"d13f3430-d0de-4305-b41c-444d02f19954"}}},"SurveyRequestListRequest":{"type":"object","properties":{"surveyType":{"type":"string","enum":["CandidateExperience"],"description":"Returns only the survey requests of the given type. Currently, only `CandidateExperience` is supported."},"applicationId":{"description":"If provided, only returns the survey requests for the application with the supplied id.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"candidateId":{"description":"If provided, only returns the survey requests for the candidate with the supplied id.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"number"},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only survey requests updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"description":"Return survey requests created at or after this date. Unix timestamp in milliseconds.","anyOf":[{"type":"number"},{"type":"null"}]}},"required":["surveyType"],"additionalProperties":false},"SurveyRequestListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/SurveyRequest"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyUrl":"https://example.ashbyhq.com/acme/survey/e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyFormDefinitionId":"49e621fa-b342-413a-b876-5d924689c23b","applicationId":"38fdb18a-5753-48e0-8a55-d8a124c346b2","candidateId":"d13f3430-d0de-4305-b41c-444d02f19954"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"SurveySubmission":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the survey submission"},"surveyFormDefinitionId":{"description":"The unique identifier for the survey form definition","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"submittedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the survey was submitted"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the associated candidate"},"applicationId":{"description":"The unique identifier for the associated application","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"surveyType":{"type":"string","enum":["EEOC","Diversity","CandidateExperience","CandidateDataConsent","Questionnaire","QualityOfHire","HiringManagerExperience"],"description":"The type of survey"},"formDefinition":{"description":"The form schema for this survey","anyOf":[{"$ref":"#/components/schemas/FormDefinition"},{"type":"null"}]},"submittedValues":{"description":"The submitted values for the survey","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"The submitted value for a form field"},"description":"A map of form field paths to submitted values","example":{"_systemfield_name":"Gob Bluth"}},{"type":"null"}]}},"required":["id","submittedAt","candidateId","surveyType"],"additionalProperties":false},"SurveySubmissionCreateRequest":{"type":"object","properties":{"surveyFormDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier of the survey form definition to submit","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier of the candidate submitting the survey","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier of the associated application","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"submittedValues":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"The submitted value for a form field"},"description":"A map of form field paths to submitted values","example":{"_systemfield_name":"Gob Bluth"}}},"required":["surveyFormDefinitionId","candidateId","applicationId","submittedValues"],"additionalProperties":false},"SurveySubmissionCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/SurveySubmission"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyFormDefinitionId":"49e621fa-b342-413a-b876-5d924689c23b","submittedAt":"2026-05-21T02:02:17.342Z","candidateId":"d13f3430-d0de-4305-b41c-444d02f19954","applicationId":"38fdb18a-5753-48e0-8a55-d8a124c346b2","surveyType":"CandidateExperience","formDefinition":{"sections":[{"fields":[{"isRequired":false,"field":{"id":"cb539763-33a2-4172-a915-dc14d9120671","type":"NPSRating","path":"_systemfield_overall_candexp_rating","humanReadablePath":"","title":"How likely are you to recommend us to others?","isNullable":false}}]}]},"submittedValues":{"_systemfield_overall_candexp_rating":"5"}}}},"ListableSurveyType":{"type":"string","enum":["CandidateExperience","Questionnaire","HiringManagerExperience"],"description":"The survey types supported by surveySubmission.list. Supported values: CandidateExperience, Questionnaire, HiringManagerExperience."},"SurveySubmissionListRequest":{"type":"object","properties":{"surveyType":{"type":"string","enum":["CandidateExperience","Questionnaire","HiringManagerExperience"],"description":"The type of survey submissions to fetch. Supported values: CandidateExperience, Questionnaire, HiringManagerExperience.","example":"CandidateExperience","$ref":"#/components/schemas/ListableSurveyType"},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of survey submissions to return per page.","example":25,"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]},"syncToken":{"description":"A sync token to retrieve only survey submissions updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"createdAfter":{"description":"Return survey submissions created at or after this date. Unix timestamp in milliseconds.","anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["surveyType"],"additionalProperties":false},"SurveySubmissionListResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the survey submission"},"surveyFormDefinitionId":{"description":"The unique identifier for the survey form definition","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"submittedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the survey was submitted"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the associated candidate"},"applicationId":{"description":"The unique identifier for the associated application","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"surveyType":{"description":"The type of survey","$ref":"#/components/schemas/ListableSurveyType"},"formDefinition":{"description":"The form schema for this survey","anyOf":[{"$ref":"#/components/schemas/FormDefinition"},{"type":"null"}]},"submittedValues":{"description":"The submitted values for the survey","anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"description":"The submitted value for a form field"},"description":"A map of form field paths to submitted values","example":{"_systemfield_name":"Gob Bluth"}},{"type":"null"}]}},"required":["id","submittedAt","candidateId","surveyType"],"additionalProperties":false},"SurveySubmissionListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/SurveySubmissionListResult"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","surveyFormDefinitionId":"49e621fa-b342-413a-b876-5d924689c23b","submittedAt":"2026-05-21T02:02:17.342Z","candidateId":"d13f3430-d0de-4305-b41c-444d02f19954","applicationId":"38fdb18a-5753-48e0-8a55-d8a124c346b2","surveyType":"CandidateExperience","formDefinition":{"sections":[{"fields":[{"isRequired":false,"field":{"id":"cb539763-33a2-4172-a915-dc14d9120671","type":"NPSRating","path":"_systemfield_overall_candexp_rating","humanReadablePath":"","title":"How likely are you to recommend us to others?","isNullable":false}}]}]},"submittedValues":{"_systemfield_overall_candexp_rating":"5"}}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"TakeHomeAssignmentStatus":{"type":"string","enum":["WaitingOnSubmission","WaitingOnFeedback","Complete","Cancelled"],"description":"The current lifecycle status of the take-home assignment"},"TakeHomeAssignmentFile":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the file"},"name":{"type":"string","description":"The file name"},"handle":{"type":"string","description":"The file handle, which can be used with the file.info endpoint"}},"required":["id","name","handle"],"additionalProperties":false},"TakeHomeAssignmentSubmission":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the take-home submission"},"submittedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the candidate submitted"},"notesHtml":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate's submission notes rendered as HTML, if provided"},"notesPlain":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate's submission notes rendered as plain text, if provided"},"fileHandles":{"type":"array","items":{"$ref":"#/components/schemas/TakeHomeAssignmentFile"},"description":"The files submitted by the candidate"}},"required":["id","submittedAt","notesHtml","notesPlain","fileHandles"],"additionalProperties":false},"TakeHomeAssignmentReviewer":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the assigned reviewer"},"interviewEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The interview event id used for interview briefings and feedback submission"},"feedbackLink":{"type":"string","format":"uri","description":"The Ashby app link for submitting reviewer feedback"},"hasSubmittedFeedback":{"type":"boolean","description":"Whether this reviewer has submitted take-home feedback"},"feedbackSubmittedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"The timestamp when feedback was submitted, if it has been submitted"}},"required":["userId","interviewEventId","feedbackLink","hasSubmittedFeedback","feedbackSubmittedAt"],"additionalProperties":false},"TakeHomeAssignment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the take-home assignment"},"applicationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the associated application"},"candidateId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the associated candidate"},"interviewStageId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}],"description":"The interview stage associated with the take-home assignment, if any"},"interviewId":{"description":"The id of the linked interview definition for this take-home","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"interview":{"description":"The interview definition for this take-home. Only included when the request was made with `expand: [\"interview\"]`.","$ref":"#/components/schemas/Interview"},"status":{"$ref":"#/components/schemas/TakeHomeAssignmentStatus"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the take-home was created"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The timestamp when the take-home was last updated"},"submission":{"anyOf":[{"$ref":"#/components/schemas/TakeHomeAssignmentSubmission"},{"type":"null"}],"description":"The candidate submission, or null until the candidate submits"},"feedbackFormDefinitionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The feedback form definition reviewers use for this take-home"},"reviewers":{"type":"array","items":{"$ref":"#/components/schemas/TakeHomeAssignmentReviewer"},"description":"The assigned take-home reviewers"}},"required":["id","applicationId","candidateId","interviewStageId","status","createdAt","updatedAt","submission","feedbackFormDefinitionId","reviewers"],"additionalProperties":false},"TakeHomeAssignmentInfoRequest":{"type":"object","properties":{"takeHomeAssignmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the take-home assignment","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"expand":{"description":"Choose to expand the result and include the related interview definition.","anyOf":[{"type":"array","items":{"type":"string","const":"interview"}},{"type":"null"}]}},"required":["takeHomeAssignmentId"],"additionalProperties":false},"TakeHomeAssignmentListRequest":{"type":"object","properties":{"applicationId":{"description":"Filter to take-home assignments for this application","example":"7211e226-7802-41fd-8d55-2720fe9d534f","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"candidateId":{"description":"Filter to take-home assignments for this candidate","example":"bf94fe6c-2571-4745-a59e-50921782705e","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"expand":{"description":"Choose to expand results and include related interview definitions.","anyOf":[{"type":"array","items":{"type":"string","const":"interview"}},{"type":"null"}]},"cursor":{"description":"Opaque cursor indicating which page of results to fetch","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"syncToken":{"description":"An opaque token representing the last time the data was successfully synced from the API. A new, updated one is returned after successfully fetching the last page of data.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of items to return. The maximum and default value is 100.","example":25,"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]}},"additionalProperties":false},"TakeHomeAssignmentInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/TakeHomeAssignment"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","applicationId":"7211e226-7802-41fd-8d55-2720fe9d534f","candidateId":"bf94fe6c-2571-4745-a59e-50921782705e","interviewStageId":"c153b3e9-8b97-4fc0-bad1-6c654122c1f8","interviewId":"ff6c7d9d-71e3-4c9c-88b1-28824980c276","status":"WaitingOnFeedback","createdAt":"2026-04-25T02:46:41.817Z","updatedAt":"2026-04-25T02:46:46.230Z","submission":{"id":"1595e4fc-8140-454e-a25d-853b0947ecf8","submittedAt":"2026-04-25T02:46:46.230Z","notesHtml":"<p>This is my submission.</p>","notesPlain":"This is my submission.","fileHandles":[{"id":"9a9fc77a-0d83-4487-ae65-bb2f90c074f8","name":"take-home-submission.pdf","handle":"encrypted-file-handle"}]},"feedbackFormDefinitionId":"46648e83-f28f-43c4-a2a0-58e0599cff41","reviewers":[{"userId":"a6ad83df-8f93-4dc2-8588-76f29cc0b5f0","interviewEventId":"4736b6d2-5c97-43a6-a7c6-0228bf079411","feedbackLink":"https://app.ashbyhq.com/interview-briefings/4736b6d2-5c97-43a6-a7c6-0228bf079411/feedback","hasSubmittedFeedback":false,"feedbackSubmittedAt":null}]}}},"TakeHomeAssignmentListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/TakeHomeAssignment"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false},"UserInfoRequest":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the user","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId"],"additionalProperties":false},"UserListRequest":{"type":"object","properties":{"includeDeactivated":{"description":"Whether to include deactivated users in the results. Defaults to false.","type":"boolean"},"cursor":{"description":"The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.","example":"G8","anyOf":[{"type":"string"},{"type":"null"}]},"limit":{"description":"The maximum number of users to return per page. Maximum is 100.","example":25,"type":"integer","exclusiveMinimum":0,"maximum":100},"syncToken":{"description":"A sync token to retrieve only users updated since the last sync. Obtained from a previous list response.","example":"jYnEBmjzR","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"UserSearchRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"The email address to search for","example":"test@ashbyhq.com"}},"required":["email"],"additionalProperties":false},"UserInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/User"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","firstName":"Jane","lastName":"Smith","email":"jane.smith@example.com","globalRole":"Elevated Access","isEnabled":true,"updatedAt":"2024-01-15T10:30:00.000Z","managerId":"7f8e9d6c-5b4a-4e2d-9c0b-9a8f7e6d5c4b"}}},"UserListSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"nextCursor":{"description":"Cursor for the next page of results, if available","type":"string"},"moreDataAvailable":{"description":"Whether more data is available beyond this page","type":"boolean"},"syncToken":{"description":"Sync token to use for future incremental syncs. Only present on the last page.","type":"string"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","firstName":"Jane","lastName":"Smith","email":"jane.smith@example.com","globalRole":"Elevated Access","isEnabled":true,"updatedAt":"2024-01-15T10:30:00.000Z","managerId":"7f8e9d6c-5b4a-4e2d-9c0b-9a8f7e6d5c4b"}],"moreDataAvailable":false,"syncToken":"sync-token-example"}},"UserSearchSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","firstName":"Jane","lastName":"Smith","email":"jane.smith@example.com","globalRole":"Elevated Access","isEnabled":true,"updatedAt":"2024-01-15T10:30:00.000Z","managerId":"7f8e9d6c-5b4a-4e2d-9c0b-9a8f7e6d5c4b"}]}},"UserInterviewerSettingsRequest":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to get interviewer settings for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId"],"additionalProperties":false},"UserUpdateInterviewerSettingsRequest":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to update interviewer settings for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"dailyLimit":{"description":"Maximum number of interviews per day for this interviewer","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"weeklyLimit":{"description":"Maximum number of interviews per week for this interviewer","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]}},"required":["userId"],"additionalProperties":false},"UserCreateInterviewerPauseRequest":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to pause.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"startsAt":{"description":"The start date and time of the pause. Defaults to the current time if not provided.","example":"2024-01-15T00:00:00.000Z","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"endsAt":{"description":"The end date and time of the pause. If not provided, the pause is indefinite.","example":"2024-02-15T00:00:00.000Z","anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"},{"type":"null"}]},"comment":{"description":"An optional comment describing the reason for the pause.","example":"On vacation","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["userId"],"additionalProperties":false},"UserListInterviewerPausesRequest":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user to list pauses for.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId"],"additionalProperties":false},"UserDeleteInterviewerPauseRequest":{"type":"object","properties":{"interviewerPauseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interviewer pause to delete.","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPauseId"],"additionalProperties":false},"InterviewerSettings":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user"},"dailyLimit":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Maximum number of interviews per day for this interviewer"},"weeklyLimit":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Maximum number of interviews per week for this interviewer"}},"required":["userId","dailyLimit","weeklyLimit"],"additionalProperties":false},"InterviewerPause":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the interviewer pause."},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the user who is paused."},"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The start date and time of the pause period."},"endsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}],"description":"The end date and time of the pause period. If null, the pause is indefinite."},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"An optional comment describing the reason for the pause."},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","description":"The date and time when the pause was created."}},"required":["id","userId","startsAt","endsAt","comment","createdAt"],"additionalProperties":false},"InterviewerPauseDeleteResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the interviewer pause that was deleted."}},"required":["id"],"additionalProperties":false},"UserInterviewerSettingsSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerSettings"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","dailyLimit":2,"weeklyLimit":10}}},"UserUpdateInterviewerSettingsSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerSettings"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","dailyLimit":3,"weeklyLimit":15}}},"UserCreateInterviewerPauseSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPause"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","startsAt":"2024-01-15T00:00:00.000Z","endsAt":"2024-02-15T00:00:00.000Z","comment":"On vacation","createdAt":"2024-01-14T10:30:00.000Z"}}},"UserListInterviewerPausesSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/InterviewerPause"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","userId":"3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d","startsAt":"2024-01-15T00:00:00.000Z","endsAt":"2024-02-15T00:00:00.000Z","comment":"On vacation","createdAt":"2024-01-14T10:30:00.000Z"}]}},"UserDeleteInterviewerPauseSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/InterviewerPauseDeleteResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"UserCustomField":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the custom field definition"},"title":{"type":"string","description":"The title of the custom field"},"value":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"object","properties":{"country":{"description":"The country of the location","type":"string"},"region":{"description":"The region of the location","type":"string"},"city":{"description":"The city of the location","type":"string"}},"additionalProperties":{}},{"type":"null"}],"description":"The current value of the custom field"},"isPrivate":{"description":"Whether the field is private","type":"boolean"},"valueLabel":{"description":"The label of the custom field value. Only present for ValueSelect fields.","anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["id","title","value"],"additionalProperties":false},"UserSetCustomFieldValueRequest":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the employee to set the custom field value for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the Custom Field definition for the field","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"fieldValue":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"object","properties":{"country":{"description":"The country of the location","type":"string"},"region":{"description":"The region of the location","type":"string"},"city":{"description":"The city of the location","type":"string"}},"additionalProperties":{}},{"type":"null"}],"description":"The value to store in the field. Type depends on the custom field type (boolean, string, number, object, etc.)\n- Location field: An object with the following properties: `{ country: \"USA\", city: \"San Francisco\", region: \"California\" }`. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties."}},"required":["userId","fieldId","fieldValue"],"additionalProperties":false},"UserSetCustomFieldValuesRequest":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the employee to set custom field values for","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"values":{"minItems":1,"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique id of the Custom Field definition for the field","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"fieldValue":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"object","properties":{"value":{"type":"number","description":"The currency amount"},"currencyCode":{"type":"string","description":"The currency code"}},"required":["value","currencyCode"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The range type"},"minValue":{"type":"number","description":"The minimum value"},"maxValue":{"type":"number","description":"The maximum value"}},"required":["type","minValue","maxValue"],"additionalProperties":{}},{"type":"object","properties":{"type":{"type":"string","description":"The compensation range type"},"minValue":{"type":"number","description":"The minimum compensation value"},"maxValue":{"type":"number","description":"The maximum compensation value"},"currencyCode":{"type":"string","description":"The currency code"},"interval":{"type":"string","description":"The compensation interval"}},"required":["type","minValue","maxValue","currencyCode","interval"],"additionalProperties":{}},{"type":"object","properties":{"country":{"description":"The country of the location","type":"string"},"region":{"description":"The region of the location","type":"string"},"city":{"description":"The city of the location","type":"string"}},"additionalProperties":{}},{"type":"null"}],"description":"The value to store in the field. Type depends on the custom field type (boolean, string, number, object, etc.)\n- Location field: An object with the following properties: `{ country: \"USA\", city: \"San Francisco\", region: \"California\" }`. You may provide any combination of these properties and we will attempt to geocode the location. For best results, provide all three properties."}},"required":["fieldId","fieldValue"],"additionalProperties":false},"description":"Array of custom field updates to apply"}},"required":["userId","values"],"additionalProperties":false},"UserSetCustomFieldValueSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/UserCustomField"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Department","value":"Engineering","isPrivate":false}}},"UserSetCustomFieldValuesSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/UserCustomField"}}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":[{"id":"650e5f74-32db-4a0a-b61b-b9afece05023","title":"Department","value":"Engineering","isPrivate":false}]}},"WebhookType":{"type":"string","enum":["applicationSubmit","applicationUpdate","candidateHire","candidateStageChange","candidateDelete","candidateMerge","interviewPlanTransition","interviewScheduleCreate","interviewScheduleUpdate","jobCreate","jobUpdate","jobPostingUpdate","jobPostingDelete","jobPostingPublish","jobPostingUnpublish","openingCreate","offerCreate","offerUpdate","offerDelete","pushToHRIS","surveySubmit","takeHomeAssignmentAssigned","takeHomeAssignmentCancelled","takeHomeAssignmentCompleted","takeHomeAssignmentSubmitted","signatureRequestUpdate"],"description":"The type of webhook","title":"Webhook Type","examples":["applicationSubmit","candidateHire"]},"WebhookSetting":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the webhook"},"enabled":{"type":"boolean","description":"Whether or not the webhook setting is enabled"},"requestUrl":{"type":"string","format":"uri","description":"The URL the webhook will send requests to"},"secretToken":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The secret token used to sign the webhook request. See our documentation [here](https://developers.ashbyhq.com/docs/authenticating-webhooks) for more information."},"webhookType":{"$ref":"#/components/schemas/WebhookType"}},"required":["id","enabled","requestUrl","secretToken","webhookType"],"additionalProperties":false},"WebhookInfo":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The unique identifier for the webhook"},"enabled":{"type":"boolean","description":"Whether or not the webhook setting is enabled"},"requestUrl":{"type":"string","format":"uri","description":"The URL the webhook will send requests to"},"webhookType":{"$ref":"#/components/schemas/WebhookType"}},"required":["id","enabled","requestUrl","webhookType"],"additionalProperties":false},"WebhookCreateRequest":{"type":"object","properties":{"webhookType":{"description":"The type of webhook to create","$ref":"#/components/schemas/WebhookType"},"requestUrl":{"type":"string","format":"uri","description":"The URL the webhook will send requests to"},"secretToken":{"type":"string","description":"The secret token used to sign the webhook request. See our documentation [here](https://developers.ashbyhq.com/docs/authenticating-webhooks) for more information."}},"required":["webhookType","requestUrl","secretToken"],"additionalProperties":false},"WebhookUpdateRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the webhook setting to update","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"enabled":{"type":"boolean","description":"Whether or not the webhook setting is enabled"},"requestUrl":{"type":"string","format":"uri","description":"The URL the webhook will send requests to"},"secretToken":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The secret token used to sign the webhook request. Pass null to clear. See our documentation [here](https://developers.ashbyhq.com/docs/authenticating-webhooks) for more information."}},"required":["webhookId"],"additionalProperties":false},"WebhookInfoRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the webhook setting to retrieve","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["webhookId"],"additionalProperties":false},"WebhookDeleteRequest":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the webhook setting to delete","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["webhookId"],"additionalProperties":false},"WebhookCreateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/WebhookSetting"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","enabled":true,"requestUrl":"https://example.com/webhook1","webhookType":"applicationSubmit","secretToken":"your-secret-token-here"}}},"WebhookUpdateSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/WebhookSetting"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","enabled":true,"requestUrl":"https://example.com/webhook1","webhookType":"applicationSubmit","secretToken":"your-secret-token-here"}}},"WebhookInfoSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/WebhookInfo"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"id":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","enabled":true,"requestUrl":"https://example.com/webhook1","webhookType":"applicationSubmit"}}},"WebhookDeleteResult":{"type":"object","properties":{"webhookId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The id of the webhook setting that was deleted"}},"required":["webhookId"],"additionalProperties":false},"WebhookDeleteSuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","const":true},"results":{"$ref":"#/components/schemas/WebhookDeleteResult"}},"required":["success","results"],"additionalProperties":false,"example":{"success":true,"results":{"webhookId":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}}},"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Use HTTP Basic Auth to authenticate with our API. You must send your API key with every request. \nPut your API key as the basic auth username and leave the password blank.\n"},"WebhookSignature":{"type":"apiKey","in":"header","name":"Ashby-Signature","description":"[Optional] If you provide a secret token when configuring your webhook, this will be used to create a digest of the JSON payload sent with each webhook request.\nThe digest will be included in the request under the `Ashby-Signature` http header.\n\nIt will look like this:\n`Ashby-Signature: sha256=f3124911d2956f10aa3a49c43a88bdf13bba846e94f0ae2bd7c034f90239bd04`\n\nThe part before the = indicates the algorithm that was used to compute the hash digest.\n"}}}}