{"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"}],"tags":[{"name":"ashby","description":"The Ashby API"}],"paths":{"/apiKey.info":{"post":{"summary":"apiKey.info","description":"Retrieve information about the API key being used to make the request.\n\n**Requires the [`apiKeysRead`](authentication#permissions-apikeyinfo) permission.**\n","operationId":"apiKeyInfo","tags":["API Key"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Responses for the apiKey.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"title":{"type":"string","description":"The name of the API key.","example":"Custom Job Board API key"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"scopes":{"type":"array","description":"List of permission scopes that this API key is authorized for.","items":{"type":"string"},"example":["jobs:read","candidates:read"]}}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}},"security":[{"BasicAuth":[]}]}},"/application.changeSource":{"post":{"summary":"application.changeSource","operationId":"applicationChangeSource","description":"Change the source of an application.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationchangesource) permission.**\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application to update the source of"}]},"sourceId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The source to set on the application. Pass null to unset an application's source."}]}},"required":["applicationId","sourceId"],"example":{"applicationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","sourceId":"2c6991c5-c9e2-4af8-879e-29c5a9d26509"}}}}},"responses":{"200":{"description":"Responses from the application.changeSource endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.changeStage":{"post":{"summary":"application.changeStage","operationId":"applicationChangeStage","description":"Change the stage of an application\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationchangestage) permission.**\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application to update the stage of"}]},"interviewStageId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The interview stage to move the application to."}]},"archiveReasonId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"Archive Reason to set when moving to an Interview Stage with type: `Archived`. \nNote: You must pass this parameter when moving to an Interview Stage with type: `Archived`\n"}]},"archiveEmail":{"type":"object","properties":{"communicationTemplateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the communication template to use for the email.\nNote: This communication template's intendedTypes must include: `email`.\n"}]},"sendAt":{"type":"string","format":"date-time","description":"The date and time to send the email as an ISO 8601 date and time string, e.g. `2025-02-24T08:27:01Z`.\nIf omitted, the email will be scheduled for the following morning at 9:32am in your default timezone.\nIf the time is in the past, the email will be sent immediately.\nNote: If a timezone is not specified, timestamps will be interpreted in UTC, regardless of your timezone setting.\n"}},"description":"Email to send to the candidate when moving to an Interview Stage with type: `Archived`.\nNote: If application is already archived, the email will not be sent.\nNote: If email send fails, the application stage will not be updated. If this is the case, you can retry the request without this parameter.\nNote: You may only pass this parameter if the application is moving to an Interview Stage with type: `Archived`.\n","required":["communicationTemplateId"]}},"required":["applicationId","interviewStageId"],"example":{"applicationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","interviewStageId":"2c6991c5-c9e2-4af8-879e-29c5a9d26509"}}}}},"responses":{"200":{"description":"Responses from the application.changeStage endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}},"required":["results"]}]},{"allOf":[{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"},{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","enum":["invalid_input","application_not_found","interview_plan_not_found","interview_stage_not_found","archive_reason_not_found","communication_template_not_found","communication_template_not_allowed"]},"description":"| Error Code | Description |\n|------------|-------------|\n| `invalid_input` | A parameter is the wrong type |\n| `invalid_input` | Archive fields are not allowed for non-archive stages |\n| `invalid_input` | Archive reason ID is required for archive stages |\n| `application_not_found` |  |\n| `interview_plan_not_found` |  |\n| `interview_stage_not_found` |  |\n| `archive_reason_not_found` |  |\n| `communication_template_not_found` |  |\n| `communication_template_not_allowed` | Template contains unresolvable substitution tokens |\n| `communication_template_not_allowed` | Template intended types does not include 'email' |\n| `communication_template_not_allowed` | [Less common] Template is archived |\n| `communication_template_not_allowed` | [Less common] Template is a one-off template |\n"}}}]}]}}}}}}},"/application.create":{"post":{"summary":"application.create","operationId":"applicationCreate","description":"Consider a candidate for a job (eg 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\n**Requires the [`candidatesWrite`](authentication#permissions-applicationcreate) permission.**\n\nTo set values for custom fields on Applications, use the [`customFields.setValue`](ref:customfieldsetvalue) endpoint.\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate to consider for a job"}]},"jobId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the job to consider the candidate for"}]},"interviewPlanId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interview plan to place the application in. If none is provided, the default interview plan is used.\n"}]},"interviewStageId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The interview stage of the interview plan (either default or provided) to place the application in. \nIf none is provided, the application is placed in the first \"Lead\" stage. \nYou can also supply the special string \"FirstPreInterviewScreen\", which will choose the first pre-interview-screen stage on the specified job's interview plan.\n"}]},"sourceId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The source to set on the application being created."}]},"creditedToUserId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user the application will be credited to."}]},"createdAt":{"allOf":[{"description":"An ISO date string to set the application's `createdAt` timestamp. When this value isn't provided, the `createdAt` timestamp defaults to the time the call was made.\n"},{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}]},"applicationHistory":{"allOf":[{"type":"array","description":"An array of objects representing the application history.","items":{"type":"object","properties":{"stageId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ID of the interview stage for this history event. This stage must belong to the interview plan associated with the application."}]},"stageNumber":{"allOf":[{"type":"integer"},{"description":"The sort order of this event. 0 is the first, the highest number will be the current stage."}]},"enteredStageAt":{"allOf":[{"$ref":"#/paths/~1candidate.addEmailMessage/post/requestBody/content/application~1json/schema/properties/sentAt/allOf/0"},{"description":"An ISO date string representing the time the application entered this stage."}]},"archiveReasonId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ID of the archive reason. If the interview stage is an `Archived` stage type, this field is required."}]}},"required":["stageId","stageNumber","enteredStageAt"]}},{"description":"An array of objects representing the application history.\n"}]}},"required":["candidateId","jobId"],"example":{"candidateId":"3ae2b801-19f6-41ef-ad28-214bd731948f","jobId":"2c6991c5-c9e2-4af8-879e-29c5a9d26509"}}}}},"responses":{"200":{"description":"Responses from the application.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.info":{"post":{"summary":"application.info","operationId":"applicationInfo","description":"Fetch application details by application id or by submitted form instance id (which is return by the `applicationForm.submit` endpoint). If both applicationId and submittedFormInstanceId are provided, we will lookup by applicationId.\n\n**Requires the [`candidatesRead`](authentication#permissions-applicationinfo) permission.**\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"applicationId":{"allOf":[{"description":"The id of the application to fetch."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"expand":{"type":"array","description":"Choose to expand the result and include additional data for related objects. \n","items":{"type":"string","enum":["openings","applicationFormSubmissions","referrals"]}}},"required":["applicationId"]},{"type":"object","properties":{"submittedFormInstanceId":{"allOf":[{"description":"The id of the application's submitted form instance to fetch."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"expand":{"type":"array","description":"Choose to expand the result and include additional data for related objects. \n","items":{"type":"string","enum":["openings","applicationFormSubmissions"]}}},"required":["submittedFormInstanceId"]}]}}}},"responses":{"200":{"description":"Responses from the application.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"allOf":[{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"},{"type":"object","properties":{"openings":{"description":"The openings array will only be included if the `openings` expand parameter is included when the request is made.","type":"array","items":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}}}},{"type":"object","properties":{"applicationHistory":{"type":"array","items":{"$ref":"#/paths/~1application.listHistory/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"}},"applicationFormSubmissions":{"type":"array","description":"Application form submissions. These match the response from the `applicationForm.submit` endpoint. Use of the expand parameter is required to fetch.","items":{"$ref":"#/paths/~1applicationForm.submit/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/submittedFormInstance"}},"referrals":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"referredAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}}}},"resumeFileHandle":{"description":"The id, name and handle for the application's resume","$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/fileHandles/items"}}}]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.list":{"post":{"summary":"application.list","operationId":"applicationList","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.**\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"},{"properties":{"status":{"type":"string","enum":["Hired","Archived","Active","Lead"]},"jobId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"expand":{"type":"array","description":"Choose to expand the result and include additional data for related objects. \n","items":{"type":"string","enum":["openings"]}}}}]}}}},"responses":{"200":{"description":"Responses from the application.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"allOf":[{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"},{"$ref":"#/paths/~1application.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/allOf/1"}]}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.transfer":{"post":{"summary":"application.transfer","operationId":"applicationTransfer","description":"Transfer an application to a different job.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationtransfer) permission.**\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application to transfer."}]},"jobId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the job to transfer the application to."}]},"interviewPlanId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interview plan to transfer the application to. \n"}]},"interviewStageId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The interview stage of the interview plan to transfer the application to. \n"}]},"startAutomaticActivities":{"allOf":[{"type":"boolean"},{"description":"Whether to start any automatic activities set on the target interview stage. \nIf not provided, the default value is `true`.\n"},{"default":true}]}},"required":["applicationId","jobId","interviewPlanId","interviewStageId"],"example":{"applicationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","jobId":"2c6991c5-c9e2-4af8-879e-29c5a9d26509","interviewPlanId":"af94aedd-b743-462c-ab22-9e7e356c11b4","interviewStageId":"5eb15197-8664-48fd-99cf-fbdc9d25149d"}}}}},"responses":{"200":{"description":"Responses from the application.transfer endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.update":{"post":{"summary":"application.update","operationId":"applicationUpdate","description":"Update an application\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationupdate) permission.**\n\nTo set values for custom fields on Applications, use the [`customFields.setValue`](ref:customfieldsetvalue) endpoint.\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application to update"}]},"sourceId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The source to set on the application being created."}]},"creditedToUserId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user the application will be credited to."}]},"createdAt":{"allOf":[{"description":"An ISO date string to set the application's `createdAt` timestamp. When this value isn't provided, the `createdAt` timestamp defaults to the time the call was made.\n"},{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}]},"sendNotifications":{"type":"boolean","default":true,"description":"Whether or not users who are subscribed to the application should be notified that application was updated. Default is true."}},"required":["applicationId"],"example":{"applicationId":"3ae2b801-19f6-41ef-ad28-214bd731948f","createdAt":"2021-01-01T00:00:00Z","creditedToUserId":"3ae2b801-19f6-41ef-ad28-214bd731948f","sourceId":"3ae2b801-19f6-41ef-ad28-214bd731948f"}}}}},"responses":{"200":{"description":"Responses from the application.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.updateHistory":{"post":{"summary":"application.updateHistory","operationId":"applicationUpdateHistory","description":"Update the history of an application. This endpoint is used to update the history of an application, such as setting the entered stage time or deleting a history event.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationupdatehistory) permission and the `Allow updating application history?` setting found in your admin API key permissions configuration.**\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"applicationId":{"allOf":[{"description":"The id of the application to fetch."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"applicationHistory":{"type":"array","description":"The updated array of application history events. This array should contain all history events for the application, not just the events being updated.","items":{"type":"object","properties":{"stageId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"stageNumber":{"type":"integer","title":"Stage Number","description":"The order of the history event in the application's history. 0 is the first event."},"enteredStageAt":{"description":"The time the application entered the stage.","$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"applicationHistoryId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","title":"Application History ID","description":"The id of the application history event to update if you are updating an existing event."},"archiveReasonId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","title":"Archive Reason ID","description":"The id of the archive reason to associate with the history event if the stage type is `archived`."}},"required":["stageId","stageNumber","enteredStageAt"]}}},"required":["applicationId","applicationHistory"]}]}}}},"responses":{"200":{"description":"Responses from the application.updateHistory endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"allOf":[{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"},{"$ref":"#/paths/~1application.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/allOf/1"},{"type":"object","properties":{"applicationHistory":{"type":"array","items":{"$ref":"#/paths/~1application.listHistory/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"}},"applicationFormSubmissions":{"type":"array","description":"Application form submissions. These match the response from the `applicationForm.submit` endpoint. Use of the expand parameter is required to fetch.","items":{"$ref":"#/paths/~1applicationForm.submit/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/submittedFormInstance"}},"referrals":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"referredAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}}}}}}]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.listHistory":{"post":{"summary":"application.listHistory","operationId":"applicationListHistory","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.**\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"applicationId":{"allOf":[{"description":"The id of the application to fetch."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}},{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema","required":["applicationId"]}]}}}},"responses":{"200":{"description":"Responses for the application.listHistory endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1brand.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"stageId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","title":"Title","example":"Offer"},"enteredStageAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"leftStageAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"stageNumber":{"type":"integer","title":"Stage Number","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"]},"title":"Allowed Actions","description":"Actions that can be performed on the application via `application.updateHistory`.","example":["delete","set_entered_at"]},"actorId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","title":"Actor ID","description":"The ID of the user that performed the stage change."}},"required":["id","stageId","title","enteredStageAt","allowedActions","stageNumber"]}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.listCriteriaEvaluations":{"post":{"summary":"application.listCriteriaEvaluations","operationId":"applicationListCriteriaEvaluations","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**Requires the [`candidatesRead`](authentication#permissions-applicationListCriteriaEvaluations) permission.**\n\n**Note:** This endpoint requires the AI Application Review feature to be enabled for your organization.\n","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"applicationId":{"allOf":[{"description":"The id of the application to fetch criteria evaluations for."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}},{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema"}],"required":["applicationId"]}}}},"responses":{"200":{"description":"Responses for the application.listCriteriaEvaluations endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1brand.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"type":"object","title":"Criteria Evaluation","description":"An AI-generated evaluation of how well a candidate meets a specific job criterion.","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the criteria evaluation."}]},"criterion":{"allOf":[{"type":"object","title":"Criterion Version","description":"The criterion that was evaluated, including its configuration and prompt details.","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the criterion version."}]},"title":{"type":"string","description":"The title of the criterion.","example":"Location"},"type":{"type":"string","description":"The type of criterion evaluation.","enum":["ResumePrompt","DidAnswerApplicationFormQuestion","SimilarityToAiGeneratedAnswer"],"example":"ResumePrompt"},"prompt":{"type":"string","description":"The prompt text used for AI evaluation.","example":"Evaluate if the candidate's location aligns with the job requirements."},"applicationFormDefinitionId":{"anyOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"type":"null"}],"description":"The id of the application form definition (if applicable)."},"applicationFormFieldPath":{"type":["string","null"],"description":"The path to the specific application form field (if applicable)."}},"required":["id","title","type","prompt"]},{"description":"The criterion that was evaluated."}]},"status":{"type":"string","description":"The status of the evaluation.","enum":["Pending","Completed","Failed","Skipped"],"example":"Completed"},"outcome":{"type":["string","null"],"description":"The evaluation outcome (e.g., \"Meets\", \"Does Not Meet\").","example":"Meets"},"reasoning":{"type":["string","null"],"description":"The AI's reasoning for the evaluation outcome.","example":"The candidate's location in San Francisco aligns well with the job's requirement for Bay Area presence."},"skipReason":{"type":["string","null"],"description":"The reason why the evaluation was skipped (if status is \"Skipped\").","example":"NoResume"},"outcomeNumber":{"type":["number","null"],"description":"A numerical score representing the evaluation outcome (0.0 to 1.0).","minimum":0,"maximum":1,"example":0.85},"evaluatedAt":{"type":["string","null"],"format":"date-time","description":"The date and time when the evaluation was completed.","example":"2024-01-15T10:30:00Z"}},"required":["id","criterion","status"]}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/applicationFeedback.list":{"post":{"summary":"applicationFeedback.list","operationId":"applicationFeedbackList","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 (e.g., \"Strong Hire\" for overall recommendation)\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.**\n","tags":["Application Feedback"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application you'd like to fetch feedback for"}]}}}]}}}},"responses":{"200":{"description":"Responses from the applicationFeedback.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","allOf":[{"$ref":"#/paths/~1applicationForm.submit/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/submittedFormInstance"},{"type":"object","properties":{"submittedByUser":{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"interviewId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"interviewEventId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"feedbackFormDefinitionId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"applicationHistoryId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"applicationId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"submittedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}}}],"required":["submittedByUser","applicationId"]}]},"example":[{"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"},"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"}]}},{"isRequired":false,"field":{"id":"550e8400-e29b-41d4-a716-446655440002","type":"Score","path":"technical_skills","title":"Technical Skills","humanReadablePath":"Technical Skills","isNullable":false}},{"isRequired":false,"field":{"id":"550e8400-e29b-41d4-a716-446655440003","type":"RichText","path":"detailed_feedback","title":"Detailed Feedback","humanReadablePath":"Detailed Feedback","isNullable":false}}]}]},"submittedValues":{"overall_recommendation":"hire","technical_skills":"4","detailed_feedback":"Candidate demonstrated strong problem-solving skills and wrote clean, efficient code. Good understanding of algorithms and data structures. Communication was clear throughout the interview."}}]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.addHiringTeamMember":{"post":{"summary":"application.addHiringTeamMember","description":"Adds an Ashby user to the hiring team at the application level. \n\n**Requires the [`candidateWrite`](authentication#permissions-applicationaddhiringteammember) permission.**\n","operationId":"applicationaddhiringteammember","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"required":["applicationId","teamMemberId","roleId"],"properties":{"applicationId":{"allOf":[{"description":"The application to assign the user a role on."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to assign the role to."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to assign."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}}}}},"responses":{"200":{"description":"Responses for the application.addHiringTeamMember endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1hiringTeam.addMember/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/application.removeHiringTeamMember":{"post":{"summary":"application.removeHiringTeamMember","description":"Removes an Ashby user to the hiring team at the application level. \n\n**Requires the [`candidateWrite`](authentication#permissions-applicationremovehiringteammember) permission.**\n","operationId":"applicationremovehiringteammember","tags":["Application"],"requestBody":{"content":{"application/json":{"schema":{"required":["applicationId","teamMemberId","roleId"],"properties":{"applicationId":{"allOf":[{"description":"The application to unassign the user a role from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to unassign the role from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to unassign."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}}}}},"responses":{"200":{"description":"Responses for the application.removeHiringTeamMember endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1hiringTeam.addMember/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/applicationHiringTeamRole.list":{"post":{"summary":"applicationHiringTeamRole.list","operationId":"applicationHiringTeamRoleList","description":"Gets all available hiring team roles for applications in the organization.\n\n**Requires the [`candidatesRead`](authentication#permissions-applicationHiringTeamRoleList) permission.**\n","tags":["Application Hiring Team Role"],"responses":{"200":{"description":"Responses from the applicationHiringTeamRole.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string"}},"required":["id","title"]}]}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/applicationFeedback.submit":{"post":{"summary":"applicationFeedback.submit","description":"Application feedback forms support a variety of field types. \n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationfeedbacksubmit) permission.**\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 integer between 1 and 4 submitted in the format `{ score: 4 }`\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","operationId":"applicationfeedbacksubmit","tags":["Application Feedback"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["feedbackForm","formDefinitionId","applicationId"],"properties":{"feedbackForm":{"$ref":"#/paths/~1offer.create/post/requestBody/content/application~1json/schema/properties/offerForm"},"formDefinitionId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the feedback form definition associated with the form submission"}]},"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application you're submitting feedback for"}]},"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user the feedback will be credited to.\nIf a userId is not provided, the feedback will be credited to the API key user.\n"}]}}},{"type":"object","required":["feedbackForm","formDefinitionId","applicationId","userId","interviewEventId"],"properties":{"feedbackForm":{"$ref":"#/paths/~1offer.create/post/requestBody/content/application~1json/schema/properties/offerForm"},"formDefinitionId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the feedback form definition associated with the form submission"}]},"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application you're submitting feedback for"}]},"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user the feedback will be credited to. \nThe user must be an interviewer on the interview event that feedback is being submitted for.\n"}]},"interviewEventId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interview event you're submitting feedback for.\n"}]}}}]}}}},"responses":{"200":{"description":"Responses from the applicationFeedback.submit endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"submittedFormInstance":{"$ref":"#/paths/~1applicationForm.submit/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/submittedFormInstance"}}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/applicationForm.submit":{"post":{"summary":"applicationForm.submit","description":"Submit an application for a job posting.\n\n**Requires the [`candidatesWrite`](authentication#permissions-applicationformsubmit) permission.**\n\nThe Content-Type of this request must be `multipart/form-data` or `application/json`.\n\nWhen using `application/json`, file fields should contain a handle string obtained from [`file.createFileUploadHandle`](https://developers.ashbyhq.com/reference/filecreatefileuploadhandle) with `fileUploadContext` set to `ApplicationForm`. This allows files to be uploaded directly to storage, bypassing the need to send file bytes through the API.\n\nWhen using `multipart/form-data`, file fields should reference a file part included in the multipart request body (existing behavior).\n\n**Important:** Please ensure that you check the response's `success` field and display any validation errors to candidates if it is `false`. Not doing so will result in applications not being recorded, without any notification to the candidate prompting them to resubmit. For testing purposes, you can simulate a validation failure by submitting the email address `testing-fail-validation@example.com`.\n\n**Note: The requests generated from this documentation will not work for this endpoint.**\n\nThe values accepted for each field depend on the type of field that's being filled out:\n- `Boolean` - A boolean value\n- `Date` - A date string in the format YYYY-MM-DD\n- `Email` - A valid email address\n- `Number` - An integer\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 integer between 1 and 4 submitted in the format `{ score: 4 }`\n- `Phone`, `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- `Location` - 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` - [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.\n","operationId":"applicationformsubmit","tags":["Application Form"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["jobPostingId","applicationForm"],"properties":{"jobPostingId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the job posting to submit an application for"}]},"applicationForm":{"$ref":"#/paths/~1offer.create/post/requestBody/content/application~1json/schema/properties/offerForm"},"utmData":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_campaign":{"type":"string"},"utm_medium":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}}},"tagIds":{"type":"array","description":"The ids of the tags to apply to the candidate","items":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"allowSubmissionForUnpublishedJobPosting":{"type":"boolean","example":true,"description":"Defaults to true. If you are running a custom built careers page that is statically generated, you may want to set this to true to allow applications to be submitted in the time a job is unpublished and your careers page is refreshed. If set to false, applications submitted for unpublished job postings will return a `job_posting_not_published` error."}}}},"multipart/form-data":{"schema":{"type":"object","required":["jobPostingId","applicationForm"],"properties":{"jobPostingId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the job posting to submit an application for"}]},"applicationForm":{"$ref":"#/paths/~1offer.create/post/requestBody/content/application~1json/schema/properties/offerForm"},"utmData":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_campaign":{"type":"string"},"utm_medium":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}}},"tagIds":{"type":"array","description":"The ids of the tags to apply to the candidate","items":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"allowSubmissionForUnpublishedJobPosting":{"type":"boolean","example":true,"description":"Defaults to true. If you are running a custom built careers page that is statically generated, you may want to set this to true to allow applications to be submitted in the time a job is unpublished and your careers page is refreshed. If set to false, applications submitted for unpublished job postings will return a `job_posting_not_published` error."},"<file key>":{"type":"string","description":"Any file referenced in the `applicationForm`. The name of this field must exactly match the `value` on the `fieldSubmission` that references this file.","format":"binary"}}}}}},"responses":{"200":{"description":"Responses from the applicationFeedback.submit endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"submittedFormInstance":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"formDefinition":{"$ref":"#/paths/~1offer.start/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/formDefinition"},"submittedValues":{"type":"object","example":{"_systemfield_name":"Gob Bluth"}}},"required":["id","formDefinition","submittedValues"]},"formMessages":{"allOf":[{"type":"object","description":"Messages related to the application form submission. Check if the application was blocked before submitting any surveys.","properties":{"blocked":{"type":"boolean","description":"Whether the application was blocked due to configured application limits (eg too many applications submitted for a single candidate). If true, do not attempt to submit any surveys, if any.","example":true},"blockMessageForCandidateHtml":{"type":"string","description":"A message to display to the candidates regarding the application limits. If there is no message, then the candidate should not be informed that they were blocked.","example":"<div><p>Please Note: we have set up limits for applications for this role. Candidates may not apply more than 2 times in any 60 day span for any job in the Application Limit Group.</p></div>\n"}},"required":["blocked"]},{"description":"Contains information about the form submission. When `blocked` is true, \nthe application was blocked by organizational rules and no Application \nrecord was created. Do not attempt to call `application.info` with the \n`submittedFormInstanceId` as it will return an `application_blocked` error. \nThe submission is saved as a blocked submission and can be reviewed by \nadministrators.\n"}]}},"required":["submittedFormInstance","formMessages"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/approval.list":{"post":{"summary":"approval.list","operationId":"approvalList","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.**\n","tags":["Approval"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"entityType":{"type":"string","enum":["offer","job","opening"],"description":"Filter approvals by the type of entity they are associated with."},"entityId":{"type":"string","format":"uuid","description":"Filter approvals to only those associated with this specific entity ID."}}}]}}}},"responses":{"200":{"description":"Responses from the approval.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"approvalDefinitionId":{"allOf":[{"description":"The id of the approval definition associated to this approval."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"entityId":{"allOf":[{"description":"The id of the approval entity (e.g. the id of the offer version)."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"entityType":{"type":"string","enum":["offer","job","opening"]},"createdAt":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}]},"submittedAt":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},{"description":"The date when the approval was submitted and sent to users for approval."}]},"completedAt":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},{"description":"The date when the approval was completed and approved by everyone."}]},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"approvalsRequired":{"type":"integer","description":"The number of approvers required to approve this step, before the approval moves on to the next step."},"completedAt":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},{"description":"The date when the step is completed based on the number of required approvals"}]},"approvers":{"type":"array","description":"An unordered list of who can approve this step.","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of a user who is an approver for this step."}]},"decision":{"type":"string","enum":["approve","reject","pending"]},"decidedAt":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},{"description":"The date when the decision was taken by the user."}]},"requestedAt":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},{"description":"The date when the decision was sent to be approved by the user."}]}},"required":["id","userId","decision"]}}},"required":["id","approvalsRequired","approvers"]}}},"required":["id","createdAt","approvalDefinitionId","entityId","entityType","steps"]}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/approvalDefinition.update":{"post":{"summary":"approvalDefinition.update","operationId":"approvalDefinitionUpdate","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.**\n","tags":["Approval Definition"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"entityType":{"type":"string","enum":["offer"]},"entityId":{"allOf":[{"description":"The id of the approval entity being updated (e.g. the id of the offer version)."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"approvalStepDefinitions":{"type":"array","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.","items":{"type":"object","properties":{"approvalsRequired":{"type":"integer","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-zero and no more than the number of approvers in this step.","example":1},"approvers":{"type":"array","description":"An unordered list of who can approve this step.","items":{"type":"object","properties":{"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of a user who is an approver for this step."}]},"type":{"type":"string","enum":["user"]}},"required":["userId","type"]}}},"required":["approvalsRequired","approvers"]}},"submitApprovalRequest":{"type":"boolean","description":"Control whether an approval request created through this API should be immediately submitted.\nIf false, then the approval will need to be manually submitted in the Ashby app.\nDefault: false\n"}},"required":["entityType","entityId","approvalStepDefinitions"]}}}},"responses":{"200":{"description":"Responses from the approvalDefinition.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"allOf":[{"description":"The id of the approval definition."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"entityType":{"type":"string","enum":["Offer"]},"entityId":{"allOf":[{"description":"The id of the approval entity (e.g. the id of the offer version)."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"approvalStepDefinitions":{"$ref":"#/paths/~1approvalDefinition.update/post/requestBody/content/application~1json/schema/properties/approvalStepDefinitions"}},"required":["entityType","entityId","approvalStepDefinitions"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/archiveReason.list":{"post":{"summary":"archiveReason.list","description":"Lists archive reasons\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-archivereasonlist) permission.**\n","operationId":"archivereasonlist","tags":["Archive Reason"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"includeArchived":{"type":"boolean","description":"When true, includes archived interview plans","default":false}}}}}},"responses":{"200":{"description":"Responses for the archiveReason.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"}},"required":["id","text","reasonType","isArchived"]}}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/assessment.addCompletedToCandidate":{"post":{"summary":"assessment.addCompletedToCandidate","operationId":"assessmentAddCompletedToCandidate","description":"Add a completed assessment to a candidate\n\n**Requires the [`candidatesWrite`](authentication#permissions-assessmentaddcompletedtocandidate) permission.**\n","tags":["Assessment"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate, to whom to add the completed assessment"}]},"partnerId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the partner adding the assessment"}]},"assessment":{"type":"object","description":"The completed assessment","required":["assessmentTypeId","assessmentId","assessmentName","result","metadata"],"properties":{"assessmentTypeId":{"allOf":[{"description":"An identifier that uniquely identifies the assessment type"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"assessmentId":{"allOf":[{"description":"An identifier that uniquely identifies the completed assessment"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"assessmentName":{"type":"string","example":"Node Assessment","description":"The name of the assessment that was taken that will be displayed in the UI"},"result":{"allOf":[{"description":"The assessment's result"},{"$ref":"#/paths/~1assessment.addCompletedToCandidate/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/result"}]},"metadata":{"type":"array","description":"An array of metadata associated with this completed assessment","items":{"$ref":"#/paths/~1assessment.addCompletedToCandidate/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/result"}}}},"timestamp":{"allOf":[{"description":"The timestamp in milliseconds since the unix epoch, when the assessment was completed"},{"type":"integer","description":"The timestamp in milliseconds since the unix epoch, when the update occurred","format":"int64","example":1665680638489}]}},"required":["candidateId","partnerId","assessment","timestamp"]}}}},"responses":{"200":{"description":"Responses for the assessment.addCompletedToCandidate endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"object","required":["assessmentTypeId","assessmentId","assessmentName","candidateId","metadata"],"properties":{"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"assessmentId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"assessmentName":{"type":"string","example":"test-assessment-name"},"assessmentTypeId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"metadata":{"type":"array","items":{"$ref":"#/paths/~1assessment.addCompletedToCandidate/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/result"}},"result":{"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":{"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"]},"value":{"allOf":[{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"The raw value — one of string, number, or boolean\n"},{"example":10}]}},"required":["identifier","label","type","value"]}}}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"candidate":{"allOf":[{"description":"Identifier of the assessment being started"},{"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"}]}}}]},"application":{"allOf":[{"description":"The application for which the candidate is being assessed"},{"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":"#/paths/~1application.list/post/requestBody/content/application~1json/schema/allOf/1/properties/status"},{"description":"The status of the application in Ashby"}]}}}]},"job":{"allOf":[{"description":"The job for which the candidate is being assessed"},{"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":"#/paths/~1hiringTeam.addMember/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}}]}}}}}},"responses":{"200":{"description":"Responses for the assessment.start endpoint","content":{"application/json":{"schema":{"title":"Success Response","type":"object","required":["success","results"],"properties":{"success":{"type":"boolean"},"results":{"required":["assessment_id"],"properties":{"assessment_id":{"type":"string"},"update_request":{"$ref":"#/paths/~1assessment.update/post/requestBody/content/application~1json/schema"}}}}}}}},"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.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":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","description":"List of available assessments","properties":{"assessment_type_id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"name":{"type":"string"},"description":{"type":"string"}}}]}}}}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/assessment.update":{"post":{"summary":"assessment.update","operationId":"assessmentUpdate","description":"Update Ashby about the status of a started assessment.\n\n**Requires the [`candidatesWrite`](authentication#permissions-assessmentupdate) permission.**\n\n`assessment_status` is required unless `cancelled_reason` is provided.\n","tags":["Assessment"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["assessment_id","timestamp"],"properties":{"assessment_id":{"allOf":[{"description":"Identifier of the assessment being updated"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"timestamp":{"$ref":"#/paths/~1assessment.addCompletedToCandidate/post/requestBody/content/application~1json/schema/properties/timestamp/allOf/1"},"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":"#/paths/~1assessment.addCompletedToCandidate/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/result"}]},"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":"#/paths/~1assessment.addCompletedToCandidate/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/result"}]},"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":"#/paths/~1assessment.addCompletedToCandidate/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/result"}]},"cancelled_reason":{"allOf":[{"description":"The reason the assessment was cancelled. This field will signal to Ashby that the assessment is cancelled."},{"$ref":"#/paths/~1assessment.addCompletedToCandidate/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/result"}]},"metadata":{"type":"array","description":"Any other metadata about the assessment (e.g. ETA until complete). All assessment data should have unique identifiers.","items":{"$ref":"#/paths/~1assessment.addCompletedToCandidate/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/result"}}}}}}},"responses":{"200":{"description":"Responses for the assessment.start endpoint"}}}},"/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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}}}}},"responses":{"200":{"description":"Responses for the assessment.cancel endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","type":"object","$ref":"#/paths/~1assessment.start/post/responses/200/content/application~1json/schema"},{"title":"Error Response","type":"object","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/assessment.customField.list":{"post":{"summary":"customField.list (Implemented by Partner)","operationId":"assessmentPartnerCustomFieldList","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 and must be enabled for your integration. Contact Ashby if you wish to use this feature.\n","tags":["Assessment"],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Responses for the customField.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","description":"A custom field specification provided by an assessment partner","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","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"]}}},"required":["fields"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/brand.list":{"post":{"summary":"brand.list","operationId":"brandList","description":"Lists all brands for the organization.\n\n**Requires the [`organizationRead`](authentication#permissions-departmentinfo) permission.**\n","tags":["Brand"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"limit":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"cursor":"qA","limit":25}}}}},"responses":{"200":{"description":"Responses for the brand.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema/properties/cursor"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"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"]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.addEmailMessage":{"post":{"summary":"candidate.addEmailMessage","description":"Adds an email message to a candidate's profile.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateaddemailmessage) permission.**\n","operationId":"candidateAddEmailMessage","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["candidateId","emailProviderEmailId","subject","from","to","body"],"properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The candidate to attach this email to."}]},"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":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The Ashby user ID to associate with this email. Defaults to the API key user."}]},"sentAt":{"allOf":[{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"},{"description":"When the email was sent. Defaults to the current time."}]},"cc":{"type":"string","description":"CC recipients."},"messageUrl":{"type":"string","format":"uri","description":"URL to view the message in the partner application.","example":"https://example.com/messages/1234567890"},"messageIdHeader":{"type":"string","description":"RFC 5322 message identifier.","example":"<CADkMx=Abc123@examplemail.com>"},"threadId":{"type":"string","description":"Thread identifier to group this message with others. Defaults to emailProviderEmailId."},"isPrivate":{"type":"boolean","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.","default":false}}}}}},"responses":{"200":{"description":"Responses for the candidate.addEmailMessage endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","description":"An email sent to or from a candidate.","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","description":"The unique id of the email in Ashby."},"candidateId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","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":{"type":["string","null"],"description":"The body of the email. Can be HTML or plain text."},"sentAt":{"$ref":"#/paths/~1candidate.addEmailMessage/post/requestBody/content/application~1json/schema/properties/sentAt/allOf/0","description":"When the email was sent."},"cc":{"type":["string","null"],"description":"CC recipients."},"messageUrl":{"type":["string","null"],"format":"uri","description":"URL to view the message in the partner application."},"messageIdHeader":{"type":["string","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","sentAt","isPrivate","userIsSender","threadId"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.addProject":{"post":{"summary":"candidate.addProject","operationId":"candidateaddproject","description":"Adds the candidate to a project.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateaddproject) permission.**\n","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate"}]},"projectId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the project"}]}},"required":["candidateId","projectId"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004","projectId":"bcffca12-5b09-4a76-acf2-00a8e267b222"}}}}},"responses":{"200":{"description":"Responses from the candidate.addProject endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.addTag":{"post":{"summary":"candidate.addTag","description":"Adds a tag to a candidate\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateaddtag) permission.**\n","operationId":"candidateAddTag","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["candidateId","tagId"],"properties":{"candidateId":{"type":"string","description":"The unique id of the candidate to add the tag to.","example":"5b591aed-88e3-4395-b9c6-7d529f93354a"},"tagId":{"type":"string","description":"The unique id of the tag to add to the candidate.","example":"38430ede-5bd2-41fc-b474-87591cb98cbc"}}}}}},"responses":{"200":{"description":"Responses for the candidate.addTag endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.anonymize":{"post":{"summary":"candidate.anonymize","description":"Anonymizes a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateanonymize) permission.**\n\n**Note**: this action cannot be reversed and requires all of a candidate's applications to be in the archived or hired state.\n","operationId":"candidateAnonymize","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["candidateId"],"properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate to anonymize."}]}}}}}},"responses":{"200":{"description":"Responses for the candidate.anonymize endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","description":"The anonymized candidate","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.create":{"post":{"summary":"candidate.create","operationId":"candidateCreate","description":"Creates a new candidate\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidatecreate) permission.**\n\nTo set values for custom fields on Candidates, use the [`customFields.setValue`](ref:customfieldsetvalue) endpoint.\n","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Adam Hart","description":"The first and last name of the candidate to be created."},"email":{"allOf":[{"type":"string","example":"test@ashbyhq.com"},{"description":"Primary, personal email of the candidate to be created."}]},"phoneNumber":{"allOf":[{"type":"string","example":"555-555-5555"},{"description":"Primary, personal phone number of the candidate to be created."}]},"linkedInUrl":{"type":"string","example":"https://linkedin.com/in/user","description":"Url to the candidate's LinkedIn profile. Must be a valid Url."},"githubUrl":{"type":"string","example":"https://github.com/user","description":"Url to the candidate's Github profile. Must be a valid Url."},"website":{"type":"string","example":"https://twitter.com/user","description":"Url of the candidate's website. Must be a valid Url."},"alternateEmailAddresses":{"type":"array","items":{"type":"string"},"example":["test.email@ashbyhq.com"],"description":"Array of alternate email address to add to the candidate's profile."},"sourceId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The source to set on the candidate being created."}]},"creditedToUserId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user the candidate will be credited to."}]},"location":{"type":"object","description":"The location of the candidate.","properties":{"city":{"type":"string","example":"San Francisco","description":"The city of the candidate's location."},"region":{"type":"string","example":"California","description":"The region (state, province, etc.) of the candidate's location."},"country":{"type":"string","example":"United States","description":"The country of the candidate's location."}}},"createdAt":{"allOf":[{"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.\n"},{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}]}},"required":["name"]}}}},"responses":{"200":{"description":"Responses for the candidate.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.createNote":{"post":{"summary":"candidate.createNote","description":"Creates a note on a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidatecreatenote) permission.**\n\nFor notes submitted with a type of `text/html`, we support the elements listed below. Any unsupported elements will be stripped out of the note's content before posting.\n  - Bold `<b>`\n  - Italic `<i>`\n  - Underline `<u>`\n  - Links `<a>`\n  - Bulleted Lists - `<ul>`, `<li>`\n  - Ordered Lists - `<ol>`, `<li>`\n  - Code - `<code>`\n  - Code Block - `<pre>`\n","operationId":"candidateCreateNote","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"candidateId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"note":{"oneOf":[{"type":"string","description":"The note to add to the candidate","example":"Strong candidate, very interested in the company"},{"type":"object","description":"Note content","properties":{"type":{"type":"string","enum":["text/plain","text/html"],"description":"The content type of the note. For notes submitted with a type of text/html we support the elements listed below. Any unsupported elements will be stripped out of the note's content before posting.\n- Bold `<b>`\n- Italic `<i>`\n- Underline `<u>`\n- Links `<a>`\n- Bulleted Lists - `<ul>`, `<li>`\n- Ordered Lists - `<ol>`, `<li>`\n- Code - `<code>`\n- Code Block - `<pre>`\n"},"value":{"type":"string"}},"required":["type","value"]}]},"sendNotifications":{"type":"boolean","description":"Whether or not users who are subscribed to the candidate should be notified that the note was posted. Default is false.","default":false},"isPrivate":{"type":"boolean","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.","default":false},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["candidateId","note"]}}}},"responses":{"200":{"description":"Responses for the candidate.createNote endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"isPrivate":{"type":"boolean","description":"Whether the note is private. Private notes require \"Allow access to non-offer private fields?\" API key permission to create and view.","example":false},"content":{"type":"string","example":"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."},"author":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"email":{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/email/allOf/0"}},"required":["id","firstName","lastName"]}},"required":["id","createdAt","isPrivate","author"]}}}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.info":{"post":{"summary":"candidate.info","operationId":"candidateInfo","description":"Gets a single candidate by id.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidateinfo) permission.**\n","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The id of the candidate to fetch"}},"required":["id"],"example":{"id":"f9e52a51-a075-4116-a7b8-484deba69004"}},{"type":"object","properties":{"externalMappingId":{"type":"string","description":"An id assigned to a candidate outside of Ashby. \nUsed to associate Ashby candidates with their profiles in external systems (BambooHR, Rippling, Gusto, etc.)\n"}},"required":["externalMappingId"],"example":{"externalMappingId":"f9e52a51-a075-4116-a7b8-484deba69004"}}]}}}},"responses":{"200":{"description":"Responses from the candidate.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","description":"The unique id of the candidate"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"updatedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"primaryEmailAddress":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application/properties/candidate/properties/primaryEmailAddress"},"emailAddresses":{"type":"array","items":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application/properties/candidate/properties/primaryEmailAddress"}},"primaryPhoneNumber":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application/properties/candidate/properties/primaryEmailAddress"},"phoneNumbers":{"type":"array","items":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application/properties/candidate/properties/primaryEmailAddress"}},"socialLinks":{"type":"array","items":{"$ref":"#/paths/~1candidate.update/post/requestBody/content/application~1json/schema/properties/socialLinks/items"}},"tags":{"type":"array","items":{"$ref":"#/paths/~1candidateTag.create/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"position":{"type":"string","example":"Software Engineer"},"company":{"type":"string","example":"Auction.com"},"school":{"type":"string","example":"Princeton University"},"applicationIds":{"type":"array","description":"The unique ids of all applications associated with the candidate","items":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/fileHandles/items"},"fileHandles":{"description":"The id, name and handle for each file associated with the candidate","type":"array","items":{"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"}}},"customFields":{"type":"array","description":"All custom field values associated with the candidate","items":{"$ref":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"description":"The source that created this candidate","$ref":"#/paths/~1source.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"},"creditedToUser":{"description":"The user who receives credit for this candidate","$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","description":"The location's unique id."},"locationSummary":{"type":"string","description":"A human-readable summary of the location.","example":"United States, California, San Francisco"},"locationComponents":{"type":"array","description":"The individual components of the location.","items":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["Country","Region","City"],"description":"The type of the location component."},"name":{"type":"string","description":"The name of the location component."}}},"example":[{"type":"Country","name":"United States"},{"type":"Region","name":"California"},{"type":"City","name":"San Francisco"}]}},"required":["id","locationSummary","locationComponents"]},"fraudStatus":{"type":["string","null"],"description":"The fraud status of the candidate.\n\nPossible values:\n- `Fraudulent` — Candidate has been marked as fraudulent.\n- `NotFraudulent` — Candidate has been marked as not fraudulent (false positive).\n- `Unsure` — Candidate has been marked as uncertain, flagged for continued monitoring.\n- `Unreviewed` — Fraud signals were detected and need a human review.\n- `PassedFraudCheck` — Candidate passed the fraud check.\n","enum":["Fraudulent","NotFraudulent","Unsure","Unreviewed","PassedFraudCheck",null],"example":"Fraudulent"}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.list":{"post":{"summary":"candidate.list","operationId":"candidateList","description":"Lists all candidates in an 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-candidatelist) permission.**\n","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"Responses for the candidate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.listClientInfo":{"post":{"summary":"candidate.listClientInfo","operationId":"candidateListClientInfo","description":"Lists all client info records for a candidate.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidatelistclientinfo) permission.**\n","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate to fetch client info for"}]}}},{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"}],"required":["candidateId"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004"}}}}},"responses":{"200":{"description":"Responses for the candidate.listClientInfo endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ID of this client information record.","example":"7d31034c-790b-4265-bf63-d65396d59d0b"}]},"ipAddress":{"type":"string","description":"The IP address (v4 or v6) that the client used to interact with the system.","example":"86.234.23.243"},"userAgent":{"type":"string","description":"The user agent that was received from the client when it interacted with the system.","example":"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":{"allOf":[{"type":"string","enum":["application","blocked_application_submission","meeting_availability_request"]},{"description":"The type of the entity that the client interacted with. Might be expanded in the future if we start capturing new client interactions.","example":"application"}]},"relatedEntityId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ID of the entity that was related to the client interaction.","example":"57133f77-9362-4397-b395-03bda1f72303"}]},"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ID of the candidate that interacted with the system.","example":"9d22854f-c929-4b86-9f42-cb71cc0e4fc7"}]},"createdAt":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}]}},"required":["id","ipAddress","relatedEntityType","relatedEntityId","candidateId"]}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.listFraudChecks":{"post":{"summary":"candidate.listFraudChecks","operationId":"candidateListFraudChecks","description":"Fetches a paginated list of fraud checks for a candidate, including the fraud signals detected in each check.\n\nEach fraud check contains a list of fraud signals with their category, name, description, and optional value.\n\n**Field Stability:**\n- `id` fields are stable and will not change.\n- `category`, `name`, `description`, and `value` fields on fraud signals are unstable and may change as signals are added, renamed, or recategorized.\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-candidatelistfraudchecks) permission.**\n\n**Note:** This endpoint requires Fraud Detection feature to be enabled for your organization.\n","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"candidateId":{"allOf":[{"description":"The id of the candidate to fetch fraud checks for."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}},{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema"}],"required":["candidateId"]}}}},"responses":{"200":{"description":"Responses for the candidate.listFraudChecks endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1brand.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","title":"Fraud Check","description":"A fraud check performed on a candidate, containing the fraud signals that were detected.","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique identifier of this fraud check."}]},"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate this fraud check belongs to."}]},"applicationId":{"type":["string","null"],"format":"uuid","description":"The id of the application this fraud check is associated with, if any.","example":"f5b1e9a2-3c4d-4e5f-9a0b-1c2d3e4f5a6b"},"createdAt":{"type":"string","format":"date-time","description":"When this fraud check was performed.","example":"2025-01-15T10:30:00.000Z"},"fraudSignals":{"type":"array","description":"The fraud signals detected during this fraud check.","items":{"type":"object","title":"Fraud Signal","description":"A fraud signal detected during a candidate fraud check.","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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\".\n\n**Note:** This field is unstable and may change over time.\n","example":"Spoofing"},"name":{"type":"string","description":"A human-readable name for this fraud signal.\n\n**Note:** This field is unstable and may change over time.\n","example":"VPN Connection Detected"},"description":{"type":"string","description":"A description of what this fraud signal means.\n\n**Note:** This field is unstable and may change over time.\n","example":"Applicant is hiding their real location using a VPN."},"value":{"type":"string","description":"An optional value associated with this signal, providing additional context (e.g., location information, account counts).\nOnly present when a value exists for the signal.\n\n**Note:** This field is unstable and may change over time.\n","example":"Copenhagen, DK"}},"required":["id","category","name","description"]}}},"required":["id","candidateId","applicationId","createdAt","fraudSignals"]}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.setFraudStatus":{"post":{"summary":"candidate.setFraudStatus","operationId":"candidateSetFraudStatus","description":"This endpoint allows marking candidates as fraudulent, not fraudulent, or unsure after reviewing their fraud signals via `candidate.listFraudChecks`.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidatesetfraudstatus) permission.**\n\n**Note:** This endpoint requires the Fraud Detection feature to be enabled for your organization.\n","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"description":"The id of the candidate to set the fraud status for."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"fraudStatus":{"type":"string","enum":["Fraudulent","NotFraudulent","Unsure"],"description":"The fraud status to set for the candidate.\n\n- `Fraudulent` — Mark the candidate as fraudulent.\n- `NotFraudulent` — Mark the candidate as not fraudulent (false positive).\n- `Unsure` — Mark the candidate as unsure, flagged for continued monitoring.\n","example":"Fraudulent"}},"required":["candidateId","fraudStatus"]}}}},"responses":{"200":{"description":"Responses for the candidate.setFraudStatus endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.listNotes":{"post":{"summary":"candidate.listNotes","operationId":"candidateListNotes","description":"Lists all notes on a candidate.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`candidatesRead`](authentication#permissions-candidatelistnotes) permission.**\n","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate to fetch notes for"}]}}},{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"}],"required":["candidateId"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004"}}}}},"responses":{"200":{"description":"Responses for the candidate.listNotes endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1candidate.createNote/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.listProjects":{"post":{"summary":"candidate.listProjects","operationId":"candidateListProjects","description":"Lists all projects on a candidate.\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-candidatelistprojects) permission.**\n","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate to fetch projects for"}]}},"required":["candidateId"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004"}},{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"}]}}}},"responses":{"200":{"description":"Responses for the candidate.listProjects endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1brand.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1project.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.removeProject":{"post":{"summary":"candidate.removeProject","operationId":"candidateremoveproject","description":"Removes the candidate from a project.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateremoveproject) permission.**\n","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate"}]},"projectId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the project"}]}},"required":["candidateId","projectId"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004","projectId":"bcffca12-5b09-4a76-acf2-00a8e267b222"}}}}},"responses":{"200":{"description":"Responses from the candidate.removeProject endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.removeTag":{"post":{"summary":"candidate.removeTag","description":"Removes a tag from a candidate.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateremovetag) permission.**\n","operationId":"candidateRemoveTag","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["candidateId","tagId"],"properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate to remove the tag from."}]},"tagId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the tag to remove from the candidate."}]}},"example":{"candidateId":"5b591aed-88e3-4395-b9c6-7d529f93354a","tagId":"38430ede-5bd2-41fc-b474-87591cb98cbc"}}}}},"responses":{"200":{"description":"Responses for the candidate.removeTag endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.search":{"post":{"summary":"candidate.search","operationId":"candidateSearch","description":"Search for candidates by email and / or name. \n\n**Requires the [`candidatesRead`](authentication#permissions-candidatesearch) permission.**\n\nResponses are limited to 100 results. Consider refining your search or using /candidate.list to paginate through all candidates, if you approach this limit. This API is for use cases where you intend to operate on a final small set of candidates, like building a candidate autocomplete.\n\nNote: When multiple search parameters are provided, the parameters are combined with the `AND` operator.\n","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The candidate's email"},"name":{"type":"string","description":"The candidate's name"}},"example":{"email":"test@ashbyhq.com","name":"Adam Hart"}}}}},"responses":{"200":{"description":"Responses for the candidate.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.update":{"post":{"summary":"candidate.update","operationId":"candidateUpdate","description":"Updates an existing candidate\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateupdate) permission.**\n\nTo set values for custom fields on Candidates, use the [`customFields.setValue`](ref:customfieldsetvalue) endpoint.\n","tags":["Candidate"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique id of the candidate to update."}]},"name":{"type":"string","example":"Adam Hart","description":"The first and last name of the candidate to update."},"email":{"allOf":[{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/email/allOf/0"},{"description":"Primary, personal email of the candidate to update."}]},"phoneNumber":{"allOf":[{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/phoneNumber/allOf/0"},{"description":"Primary, personal phone number of the candidate to update."}]},"linkedInUrl":{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/linkedInUrl"},"githubUrl":{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/githubUrl"},"websiteUrl":{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/website"},"alternateEmail":{"type":"string","example":"test.email@ashbyhq.com","description":"An alternate email address to add to the candidate's profile."},"socialLinks":{"description":"An array of social links to set on the candidate. This value replaces existing socialLinks that have been set on the candidate. \nIf this value is submitted along with linkedInUrl, gitHubUrl or websiteUrl fields, those values will be ignored.\n","type":"array","items":{"type":"object","properties":{"type":{"enum":["LinkedIn","GitHub","Twitter","Medium","StackOverflow","YouTube","CodePen","Website"]},"url":{"type":"string"}},"required":["type","url"],"example":{"url":"https://linkedin.com/in/user","type":"LinkedIn"}}},"sourceId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of source for this candidate."}]},"creditedToUserId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user the candidate will be credited to."}]},"location":{"type":"object","description":"The location of the candidate.","properties":{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/location/properties"}},"createdAt":{"allOf":[{"description":"An ISO date string to set the candidate's `createdAt` timestamp.\n"},{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}]},"sendNotifications":{"type":"boolean","default":true,"description":"Whether or not users who are subscribed to the candidate should be notified that candidate was updated. Default is true."}},"required":["candidateId"]}}}},"responses":{"200":{"description":"Responses for the candidate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.uploadFile":{"post":{"summary":"candidate.uploadFile","operationId":"candidateUploadFile","description":"Uploads a file to attach to the candidate's profile.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateuploadfile) permission.**\n\n**Recommended: Presigned upload handle**\nUse `file.createFileUploadHandle` with `fileUploadContext: \"CandidateFiles\"` to get a presigned URL. Upload the file directly to that URL, then call this endpoint with the returned `fileHandle`. This avoids sending file bytes through the API, improving upload reliability and reducing latency for large files.\n\n**Deprecated: Multipart upload**\nSend the file as `multipart/form-data` with the file in a `file` field. This mode is deprecated and may be removed in a future API version.\n","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate"}]},"fileHandle":{"type":"string","description":"A handle returned by `file.createFileUploadHandle` after uploading a file to the presigned URL."}},"required":["candidateId","fileHandle"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate"}]},"file":{"type":"string","format":"binary","deprecated":true,"description":"Deprecated: Use `file.createFileUploadHandle` with `fileHandle` instead. The file to upload to the candidate's profile."}},"required":["candidateId","file"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004","file":"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDIgMCBSL01"}}}}},"responses":{"200":{"description":"Responses from the candidate.uploadFile endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidate.uploadResume":{"post":{"summary":"candidate.uploadResume","operationId":"candidateUploadResume","description":"Uploads a candidate's resume, parses it, and updates their information.\n\n**Requires the [`candidatesWrite`](authentication#permissions-candidateuploadresume) permission.**\n\n**Recommended: Presigned upload handle**\nUse `file.createFileUploadHandle` with `fileUploadContext: \"CandidateResume\"` to get a presigned URL. Upload the file directly to that URL, then call this endpoint with the returned `resumeHandle`. This avoids sending file bytes through the API, improving upload reliability and reducing latency for large files.\n\n**Deprecated: Multipart upload**\nSend the resume as `multipart/form-data` with the file in a `resume` field. This mode is deprecated and may be removed in a future API version.\n\nNote: Existing candidate data always takes precedence over data found by parsing the resume. Resume data only populates candidate data, if it's data that was missing in the candidate model.\n","tags":["Candidate"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate"}]},"resumeHandle":{"type":"string","description":"A handle returned by `file.createFileUploadHandle` after uploading a resume file to the presigned URL."}},"required":["candidateId","resumeHandle"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate"}]},"resume":{"type":"string","format":"binary","deprecated":true,"description":"Deprecated: Use `file.createFileUploadHandle` with `resumeHandle` instead. The resume to upload to the candidate's profile."}},"required":["candidateId","resume"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004","resume":"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50I"}}}}},"responses":{"200":{"description":"Responses from the candidate.uploadResume endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidateTag.archive":{"post":{"summary":"candidateTag.archive","description":"Archives a candidate tag.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-candidatetagarchive) permission.**\n","operationId":"candidateTagArchive","tags":["Candidate Tag"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["tagId"],"properties":{"tagId":{"type":"string","format":"uuid","description":"The candidate tag's unique id","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}}}}},"responses":{"200":{"description":"Responses for the candidateTag.archive endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1candidateTag.create/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidateTag.create":{"post":{"summary":"candidateTag.create","description":"Creates a candidate tag.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-candidatetagcreate) permission.**\n","operationId":"candidatetagcreate","tags":["Candidate Tag"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["title"],"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"}}}}}},"responses":{"200":{"description":"Responses for the location.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"}},"required":["id","title","isArchived"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/candidateTag.list":{"post":{"summary":"candidateTag.list","operationId":"candidateTagList","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.**\n","tags":["Candidate Tag"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"includeArchived":{"type":"boolean","default":false,"description":"Whether archived candidate tags should be included in the response"}}},{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"}]}}}},"responses":{"200":{"description":"Responses for the candidateTag.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1candidateTag.create/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/closeReason.list":{"post":{"summary":"closeReason.list","operationId":"closeReasonList","description":"Lists all close reasons for jobs or openings.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-closereasonlist) permission.**\n","tags":["Close Reason"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"includeArchived":{"type":"boolean","default":false,"description":"Whether to include archived close reasons in the response."}}}}}},"responses":{"200":{"description":"Responses for the closeReason.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"type":"object","description":"The reason a job or opening was closed","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","description":"The reason's unique id"},"reasonText":{"type":"string","description":"The text of the reason","example":"Position Filled"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"}},"required":["id","reasonText","isArchived"]}}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/communicationTemplate.list":{"post":{"summary":"communicationTemplate.list","description":"List all enabled communication templates.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-communicationtemplatelist) permission.**\n","operationId":"communicationTemplateList","tags":["Communication Template"],"responses":{"200":{"description":"Responses for the communicationTemplate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","description":"A communication template","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"updatedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"title":{"type":"string","example":"Rejection + Consideration for Future Positions"},"intendedTypes":{"type":"array","items":{"type":"string","enum":["email","inMail","linkedInConnection"]},"example":["email","inMail"]}},"required":["id","title","intendedTypes","createdAt","updatedAt"]}]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/customField.create":{"post":{"summary":"customField.create","operationId":"customFieldCreate","description":"Create a new custom field\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-customfieldcreate) permission.**\n","tags":["Custom Field"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["fieldType","objectType","title"],"properties":{"fieldType":{"type":"string","description":"The type of field being created. This value is case-sensitive.","enum":["Boolean","CompensationRange","Currency","Date","LongText","MultiValueSelect","Number","NumberRange","String","ValueSelect","Url","UUID"]},"objectType":{"type":"string","description":"The type of object the field can be associated with.","enum":["Application","Candidate","Job","Employee","Talent_Project","Opening_Version","Offer_Version"]},"title":{"type":"string","description":"The name of the field"},"description":{"type":"string","description":"A description for the field"},"selectableValues":{"type":"array","description":"Required when the field type is ValueSelect or MultiValueSelect. An array of selectable values for the field.","items":{"properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"],"type":"object"}},"isDateOnlyField":{"type":"boolean","description":"Only applies to fields with an objectType of Date. Whether or not the field includes content other than a date"},"isExposableToCandidate":{"type":"boolean","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.","default":false}}}}}},"responses":{"200":{"description":"Responses for the customField.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1customField.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/customField.info":{"post":{"summary":"customField.info","operationId":"customFieldInfo","description":"Get information about a custom field\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-customfieldinfo) permission.**\n","tags":["Custom Field"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"customFieldId":{"type":"string","format":"uuid","description":"The id of the custom field to fetch"}}}]}}}},"responses":{"200":{"description":"Responses for the customField.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"isPrivate":{"type":"boolean","example":false,"description":"A boolean indicating whether the custom field is private. If not set, this value defaults to false.\nPrivate custom fields can only be created and viewed by API keys with the \"Allow access to non-offer \nprivate fields?\" permission.\n"},"title":{"type":"string","example":"Preferred Teams"},"objectType":{"type":"string","description":"The type of object in Ashby the custom field is associated with","enum":["Application","Candidate","Employee","Job","Offer","Opening","Talent_Project"]},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"},"fieldType":{"type":"string","description":"The type of data stored in the custom field","enum":["MultiValueSelect","NumberRange","String","Date","ValueSelect","Number","Currency","Boolean","LongText","CompensationRange","NumberRange"]},"isRequired":{"type":"boolean","example":false,"description":"Indicates whether a value for this custom field must be provided in order to take certain actions on the object it is associated with.\n"},"selectableValues":{"description":"An array of values that can be selected for custom fields with a fieldType of MultiValueSelect.\nIf the fieldType is not MultiValueSelect, `selectableValues` will not be present in the response\n","type":"array","items":{"type":"object","properties":{"label":{"type":"string","example":"Backend Engineering"},"value":{"type":"string","example":"Backend Engineering"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"}}}}},"required":["id","title","objectType","isArchived","fieldType","isRequired"]}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/customField.list":{"post":{"summary":"customField.list","operationId":"customFieldList","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.**\n","tags":["Custom Field"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema","properties":{"includeArchived":{"type":"boolean","description":"If true, archived custom fields will be included in the response","default":false}}}]}}}},"responses":{"200":{"description":"Responses for the customField.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1customField.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/customField.setValue":{"post":{"summary":"customField.setValue","operationId":"customFieldSetValue","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**Requires the [`candidatesWrite`](authentication#permissions-customfieldsetvalue) permission.**\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  - Email, LongText, Phone, 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","tags":["Custom Field"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["objectId","objectType","fieldId","fieldValue"],"properties":{"objectId":{"allOf":[{"description":"The id of the object the field value is being set on."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"objectType":{"type":"string","description":"The type of object the field is associated with.","enum":["Application","Candidate","Job","Opening"]},"fieldId":{"allOf":[{"description":"The unique id of the Custom Field definition for the field"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"fieldValue":{"description":"The value to store in the field","oneOf":[{"type":"boolean","title":"Boolean","description":"A boolean value"},{"type":"string","title":"Date","format":"date-time","description":"An ISO Date string"},{"type":"string","title":"String, Email, LongText, Phone","description":"A string"},{"type":"string","title":"Url","format":"uri","description":"A valid http or https URL (e.g., https://example.com)"},{"type":"array","title":"MultiValueSelect","items":{"type":"string","description":"An array of strings that exist in the MultiValueSelect field's options"}},{"type":"number","title":"Number","description":"A number"},{"type":"object","title":"Currency","required":["value","currencyCode"],"properties":{"value":{"type":"number","example":100000},"currencyCode":{"type":"string","example":"USD"}},"description":"An object describing a currency amount"},{"type":"string","title":"ValueSelect","description":"A string that matches the value of one of the ValueSelect field's options"},{"type":"object","title":"NumberRange","required":["type","minValue","maxValue"],"properties":{"type":{"type":"string","example":"number-range"},"minValue":{"type":"number","example":10000},"maxValue":{"type":"number","example":100000}},"description":"An object describing the number range"},{"type":"string","title":"UUID","format":"uuid","description":"A valid UUID string (e.g., for Employee fields)"},{"type":"object","title":"CompensationRange","required":["type","minValue","maxValue","currencyCode","interval"],"properties":{"type":{"type":"string","example":"compensation-range"},"minValue":{"type":"number","example":10000},"maxValue":{"type":"number","example":100000},"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"}},"description":"An object describing the compensation range"}]}}}}}},"responses":{"200":{"description":"Responses for the customField.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"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"}]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/customField.setValues":{"post":{"summary":"customField.setValues","operationId":"customFieldSetValues","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**Requires the [`candidatesWrite`](authentication#permissions-customfieldsetvalues) permission.**\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  - Email, LongText, Phone, 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","tags":["Custom Field"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["objectId","objectType","values"],"properties":{"objectId":{"allOf":[{"description":"The id of the object the field values are being set on."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"objectType":{"type":"string","description":"The type of object the fields are associated with.","enum":["Application","Candidate","Job","Opening"]},"values":{"type":"array","description":"Array of custom field updates to apply","minItems":1,"items":{"type":"object","required":["fieldId","fieldValue"],"properties":{"fieldId":{"allOf":[{"description":"The unique id of the Custom Field definition for the field"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"fieldValue":{"description":"The value to store in the field","oneOf":[{"type":"boolean","title":"Boolean","description":"A boolean value"},{"type":"string","title":"Date","format":"date-time","description":"An ISO Date string"},{"type":"string","title":"String, Email, LongText, Phone","description":"A string"},{"type":"string","title":"Url","format":"uri","description":"A valid http or https URL (e.g., https://example.com)"},{"type":"array","title":"MultiValueSelect","items":{"type":"string","description":"An array of strings that exist in the MultiValueSelect field's options"}},{"type":"number","title":"Number","description":"A number"},{"type":"object","title":"Currency","required":["value","currencyCode"],"properties":{"value":{"type":"number","example":100000},"currencyCode":{"type":"string","example":"USD"}},"description":"An object describing a currency amount"},{"type":"string","title":"ValueSelect","description":"A string that matches the value of one of the ValueSelect field's options"},{"type":"object","title":"NumberRange","required":["type","minValue","maxValue"],"properties":{"type":{"type":"string","example":"number-range"},"minValue":{"type":"number","example":10000},"maxValue":{"type":"number","example":100000}},"description":"An object describing the number range"},{"type":"string","title":"UUID","format":"uuid","description":"A valid UUID string (e.g., for Employee fields)"},{"type":"object","title":"CompensationRange","required":["type","minValue","maxValue","currencyCode","interval"],"properties":{"type":{"type":"string","example":"compensation-range"},"minValue":{"type":"number","example":10000},"maxValue":{"type":"number","example":100000},"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"}},"description":"An object describing the compensation range"}]}}}}}}}}},"responses":{"200":{"description":"Responses for the customField.setValues endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/customField.updateSelectableValues":{"post":{"summary":"customField.updateSelectableValues","operationId":"customFieldUpdateSelectableValues","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.**\n","tags":["Custom Field"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["customFieldId","selectableValues"],"properties":{"customFieldId":{"type":"string","format":"uuid","description":"The id of the custom field to update"},"selectableValues":{"type":"array","description":"An array of selectable values to merge with the existing values. Only `label`, `value`, and optionally `isArchived` should be provided.","items":{"type":"object","additionalProperties":false,"required":["label","value"],"properties":{"label":{"type":"string","description":"The display label for this selectable value"},"value":{"type":"string","description":"The internal value for this selectable value (used as the unique identifier)"},"isArchived":{"type":"boolean","description":"Whether this value should be archived. Defaults to false if not provided.","default":false}}}}}}}}},"responses":{"200":{"description":"Responses for the customField.updateSelectableValues endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1customField.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/department.create":{"post":{"summary":"department.create","description":"Creates a department\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentcreate) permission.**\n","operationId":"departmentcreate","tags":["Department & Team"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the department or team","example":"Engineering Operations"},"externalName":{"type":"string","description":"An alternate candidate-facing name for this department that will be used on Ashby job boards\n","example":"Engineering"},"parentId":{"type":"string","format":"uuid","description":"The id of the department's parent department","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"},"extraData":{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/extraData"}}}}}},"responses":{"200":{"description":"Responses for the department.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1department.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/department.archive":{"post":{"summary":"department.archive","description":"Archives a department\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentarchive) permission.**\n","operationId":"departmentarchive","tags":["Department & Team"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["departmentId"],"properties":{"departmentId":{"type":"string","description":"The department's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"}}}}}},"responses":{"200":{"description":"Responses for the department.archive endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1department.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/department.restore":{"post":{"summary":"department.restore","description":"Restores a department\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentrestore) permission.**\n","operationId":"departmentrestore","tags":["Department & Team"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["departmentId"],"properties":{"departmentId":{"type":"string","description":"The department's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"}}}}}},"responses":{"200":{"description":"Responses for the department.restore endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1department.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/department.info":{"post":{"summary":"department.info","operationId":"departmentInfo","description":"Fetch department details by id\n\n**Requires the [`organizationRead`](authentication#permissions-departmentinfo) permission.**\n","tags":["Department"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"departmentId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique id of the department whose details will be fetched"}]}},"required":["departmentId"],"example":{"departmentId":"3ae2b801-19f6-41ef-ad28-214bd731948f"}}}}},"responses":{"200":{"description":"Responses from the department.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"name":{"$ref":"#/paths/~1department.create/post/requestBody/content/application~1json/schema/properties/name"},"externalName":{"$ref":"#/paths/~1department.create/post/requestBody/content/application~1json/schema/properties/externalName"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"},"parentId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"},"extraData":{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/extraData"}},"required":["id","name","isArchived","createdAt","updatedAt"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/department.list":{"post":{"summary":"department.list","operationId":"departmentList","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.**\n","tags":["Department"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"includeArchived":{"$ref":"#/paths/~1source.list/post/requestBody/content/application~1json/schema/properties/includeArchived"},"cursor":{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema/properties/cursor"},"syncToken":{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema/properties/syncToken"},"limit":{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema/properties/limit"}},"example":{"includeArchived":false,"cursor":"qA","syncToken":"6W05prn4d","limit":25}}}}},"responses":{"200":{"description":"Responses for the department.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1department.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/department.move":{"post":{"summary":"department.move","description":"Moves a department to another parent\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentmove) permission.**\n","operationId":"departmentmove","tags":["Department & Team"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["departmentId"],"properties":{"departmentId":{"type":"string","description":"The department's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"},"parentId":{"type":"string","description":"The department parent's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"}}}}}},"responses":{"200":{"description":"Responses for the department.move endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1department.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/department.update":{"post":{"summary":"department.update","description":"Updates a department\n\n**Requires the [`organizationWrite`](authentication#permissions-departmentupdate) permission.**\n","operationId":"departmentupdate","tags":["Department & Team"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["departmentId"],"properties":{"departmentId":{"type":"string","description":"The department's ID","example":"1be42b8e-cafd-4beb-8121-f4981eb20f42"},"name":{"$ref":"#/paths/~1department.create/post/requestBody/content/application~1json/schema/properties/name"},"externalName":{"$ref":"#/paths/~1department.create/post/requestBody/content/application~1json/schema/properties/externalName"},"extraData":{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/extraData"}}}}}},"responses":{"200":{"description":"Responses for the department.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1department.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/file.info":{"post":{"summary":"file.info","description":"Retrieve the url of a file associated with a candidate\n\n**Requires the [`candidatesRead`](authentication#permissions-fileinfo) permission.**\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","operationId":"fileInfo","tags":["File"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fileHandle":{"type":"string","description":"A file handle retrieved from the public API","example":"eyJoYW5kbGUiOnsidHlwZSI6IkNhbmRpZGF0ZUZpbGUiLCJmaWxlSWQiOiIxNTk1ZTRmYy04MTQwLTQ1NGUtYTI1ZC04NTNiOTQ3ZWNmYzgiLCJvd25lcklkIjoiYmY5NGZlNmMtMjU3MS00NzQ1LWE1OWEtNTA5MjE3ODI3MDVlIn0sInNpZ25hdHVyZSI6IkFqclpjT0VlTXUwdWxLZlRCS05iMWRkbDdHcjVIWFVmZzNrS0NPL1dWWjg9IiwidmVyc2lvbiI6IjEilQ\n"}},"required":["fileHandle"]}}}},"responses":{"200":{"description":"Responses for the file.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"url":{"type":"string","description":"The url of the file","example":"https://s3.amazonaws.com/..."}},"required":["url"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/file.createFileUploadHandle":{"post":{"summary":"file.createFileUploadHandle","operationId":"fileCreateFileUploadHandle","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\nBenefits over multipart upload:\n- **Reliability**: File bytes are uploaded directly to storage, avoiding timeouts and connection resets that can occur when proxying large files through the API.\n- **Compatibility**: Avoids issues with firewalls or proxies that block or scan multipart payloads containing binary content.\n- **Simplicity**: The follow-up call to, e.g., `candidate.uploadResume`, `candidate.uploadFile`, or `applicationForm.submit` is a plain `application/json` request rather than `multipart/form-data`.\n\n**Requires the [`candidatesWrite`](authentication#permissions-filecreatefileuploadhandle) permission.**\n\n**Usage flow:**\n\n1. Call `file.createFileUploadHandle` with the file metadata to get a presigned upload URL, form fields, and a handle.\n2. Upload the file directly to the returned `url` using a `multipart/form-data` POST request. Include all returned `fields` as form fields, and the file as the last field named `file`.\n3. Use the returned `handle` in a follow-up call:\n   - `candidate.uploadResume` with `{ candidateId, resumeHandle }` to attach a resume to a candidate.\n   - `candidate.uploadFile` with `{ candidateId, fileHandle }` to attach a file to a candidate.\n   - `applicationForm.submit` with `Content-Type: application/json`, where file field values in `fieldSubmissions` contain the handle string instead of a multipart file reference.\n\nThe presigned URL expires after 10 minutes. The `fileUploadContext` must be one of `CandidateResume`, `CandidateFiles`, or `ApplicationForm`.\n","tags":["File"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileUploadContext":{"type":"string","enum":["CandidateResume","CandidateFiles","ApplicationForm"],"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."},"filename":{"type":"string","description":"The name of the file being uploaded, including extension.","example":"resume.pdf"},"contentType":{"type":"string","description":"The MIME type of the file being uploaded.","example":"application/pdf"},"contentLength":{"type":"integer","description":"The size of the file in bytes.","example":102400}},"required":["fileUploadContext","filename","contentType","contentLength"]}}}},"responses":{"200":{"description":"Responses from the file.createFileUploadHandle endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"handle":{"type":"string","description":"An encrypted handle to pass to `candidate.uploadResume` (as `resumeHandle`), `candidate.uploadFile` (as `fileHandle`), or `applicationForm.submit` (as the file field value in `fieldSubmissions`) after the file has been uploaded."},"url":{"type":"string","description":"The presigned URL to upload the file to via a `multipart/form-data` POST request."},"fields":{"type":"object","additionalProperties":{"type":"string"},"description":"Form fields that must be included in the multipart upload request to the presigned URL. Include these as form fields before the file field."}},"required":["handle","url","fields"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/feedbackFormDefinition.info":{"post":{"summary":"feedbackFormDefinition.info","operationId":"feedbackFormDefinitionInfo","description":"Returns a single feedback form by id\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-feedbackformdefinitioninfo) permission.**\n","tags":["Feedback Form Definition"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["feedbackFormDefinitionId"],"properties":{"feedbackFormDefinitionId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique id of the feedback form you'd like to fetch."},{"example":"9b17887e-5add-49e8-9a03-ffffa669aa2f"}]}}}}}},"responses":{"200":{"description":"Responses for the feedbackFormDefinition.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"allOf":[{"$ref":"#/paths/~1referralForm.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/allOf/0"},{"type":"object","properties":{"organizationId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"isDefaultForm":{"type":"boolean","example":true},"interviewId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interview associated with the feedback form."}]}}}]}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/feedbackFormDefinition.list":{"post":{"summary":"feedbackFormDefinition.list","operationId":"feedbackFormDefinitionList","description":"Lists all feedback forms.\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.**\n","tags":["Feedback Form Definition"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1department.list/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"Responses for the feedbackFormDefinition.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1feedbackFormDefinition.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/hiringTeam.addMember":{"post":{"summary":"hiringTeam.addMember","description":"Adds an Ashby user to the hiring team at the application or job-level. \n\n**Requires the [`organizationWrite`](authentication#permissions-hiringteamaddmember) permission.**\n\nHiring team members can be added to a hiring team at the application, job, or opening level. \n","operationId":"hiringteamaddmember","tags":["Hiring Team"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Application-level","required":["applicationId","teamMemberId","roleId"],"properties":{"applicationId":{"allOf":[{"description":"The application to assign the user a role on."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to assign the role to."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to assign."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}},{"type":"object","title":"Job-level","required":["jobId","teamMemberId","roleId"],"properties":{"jobId":{"allOf":[{"description":"The job to assign the user a role on."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to assign the role to."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to assign."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}},{"type":"object","title":"Opening-level","required":["openingId","teamMemberId","roleId"],"properties":{"openingId":{"allOf":[{"description":"The opening to assign the user a role on."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to assign the role to."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to assign."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}}]}}}},"responses":{"200":{"description":"Responses for the hiringTeam.addMember endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"email":{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/email/allOf/0"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"required":["userId","firstName","lastName","email","role"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/hiringTeam.removeMember":{"post":{"summary":"hiringTeam.removeMember","description":"Removes an Ashby user from the hiring team at the application or job-level. \n\n**Requires the [`organizationWrite`](authentication#permissions-hiringteamremovemember) permission.**\n\nHiring team members can be removed from a hiring team at the application, job, or opening level. \n","operationId":"hiringteamremovemember","tags":["Hiring Team"],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Application-level","required":["applicationId","teamMemberId","roleId"],"properties":{"applicationId":{"allOf":[{"description":"The application to unassign the user a role from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to unassign the role from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to unassign from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}},{"type":"object","title":"Job-level","required":["jobId","teamMemberId","roleId"],"properties":{"jobId":{"allOf":[{"description":"The job to unassign the user a role from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to unassign the role from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to unassign from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}},{"type":"object","title":"Opening-level","required":["openingId","teamMemberId","roleId"],"properties":{"openingId":{"allOf":[{"description":"The opening to unassign the user a role from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to unassign the role from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to unassign from."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}}]}}}},"responses":{"200":{"description":"Responses for the hiringTeam.removeMember endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1hiringTeam.addMember/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"hiringteamrolelist","tags":["Hiring Team Role"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"namesOnly":{"type":"boolean","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.","default":true}}}}}},"responses":{"200":{"description":"Responses for the hiringTeamRole.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"namesOnly: true","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"type":"string"},"example":["Recruiter"]}},"required":["results"]}]},{"title":"namesOnly: false","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","example":"Recruiter"}}}}}}]}]}}}}}}},"/interview.info":{"post":{"summary":"interview.info","operationId":"interviewInfo","description":"Fetch interview details by id\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewinfo) permission.**\n","tags":["Interview"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique id of the interview whose details will be fetched"}]}},"required":["id"],"example":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f"}}}}},"responses":{"200":{"description":"Responses from the interview.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"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":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["id","title","isArchived","isFeedbackRequired","isFeedbackRequested","feedbackFormDefinitionId"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interview.list":{"post":{"summary":"interview.list","operationId":"interviewList","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.**\n","tags":["Interview"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"includeArchived":{"$ref":"#/paths/~1source.list/post/requestBody/content/application~1json/schema/properties/includeArchived"},"includeNonSharedInterviews":{"type":"boolean","default":false,"description":"If true, interviews that are associated with specific jobs will be included in the response. \nShared interviews that are not associated with a specific job can be scheduled for applications to any job.\nInterviews that are not shared can only be scheduled for applications to the job they are associated with.\n"},"excludeArchivedScheduleTemplateInterviews":{"type":"boolean","default":false,"description":"If true, interviews local to archived schedule templates are omitted from the response. \nThis parameter only has an effect when `includeNonSharedInterviews` is also set to true.\nShared interviews (not associated with any schedule template) are always included regardless of this setting.\n"}}}]}}}},"responses":{"200":{"description":"Responses from the interview.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1interview.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewEvent.list":{"post":{"summary":"interviewEvent.list","operationId":"interviewEventList","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.**\n","tags":["Interview Event"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"},{"type":"object","additionalProperties":false,"properties":{"interviewScheduleId":{"allOf":[{"description":"The unique ID of the interview schedule, for which to list interview events"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"expand":{"type":"array","description":"Choose to expand the result and include additional data for related objects. \n","items":{"type":"string","enum":["interview"]}}},"required":["interviewScheduleId"]}]}}}},"responses":{"200":{"description":"Responses from the interviewEvent.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The interview event's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"}]},"interviewId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The interview's id"},{"example":"ff6c7d9d-71e3-4c9c-88b1-28824980c276"}]},"interviewScheduleId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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":{"allOf":[{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},{"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":"#/paths/~1interviewerPool.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"},{"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"]}},"createdAt":{"allOf":[{"description":"The time the interview event was created"},{"$ref":"#/paths/~1candidate.addEmailMessage/post/requestBody/content/application~1json/schema/properties/sentAt/allOf/0"}],"type":"string"},"updatedAt":{"allOf":[{"description":"The time the interview event was last updated"},{"$ref":"#/paths/~1candidate.addEmailMessage/post/requestBody/content/application~1json/schema/properties/sentAt/allOf/0"}],"type":"string"},"startTime":{"allOf":[{"description":"The time the interview event is scheduled to start"},{"$ref":"#/paths/~1candidate.addEmailMessage/post/requestBody/content/application~1json/schema/properties/sentAt/allOf/0"}],"type":"string"},"endTime":{"allOf":[{"description":"The time the interview event is scheduled to end"},{"$ref":"#/paths/~1candidate.addEmailMessage/post/requestBody/content/application~1json/schema/properties/sentAt/allOf/0"}],"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":"#/paths/~1interview.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"notetakerTranscriptId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/extraData"}},"required":["id","interviewId","interviewScheduleId","interviewers","createdAt","updatedAt","startTime","endTime","feedbackLink","hasSubmittedFeedback"]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewPlan.list":{"post":{"summary":"interviewPlan.list","operationId":"interviewPlanList","description":"List published interview plans. Draft interview plans are not returned. If `includeArchived` is true, archived interview plans are also included.\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.**\n","tags":["Interview Plan"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1department.list/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"Responses from the interviewPlan.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","example":"Engineering Interview Plan"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"}},"required":["id","title","isArchived"]},{"type":"object","properties":{"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"updatedAt":{"$ref":"#/paths/~1department.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/updatedAt"}},"required":["createdAt","updatedAt"]}]}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewSchedule.cancel":{"post":{"summary":"interviewSchedule.cancel","operationId":"interviewScheduleCancel","description":"Cancel an interview schedule by id\n\n**Requires the [`interviewsWrite`](authentication#permissions-interviewschedulecancel) permission.**\n","tags":["Interview Schedule"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interview schedule to cancel"}]},"allowReschedule":{"type":"boolean","description":"Whether or not this interview schedule can be rescheduled.","default":false}},"required":["id"],"example":{"id":"3ae2b801-19f6-41ef-ad28-214bd731948f"}}}}},"responses":{"200":{"description":"Responses from the interviewSchedule.cancel endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/interviewScheduleCreate/post/requestBody/content/application~1json/schema/properties/data/properties/interviewSchedule"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewSchedule.create":{"post":{"summary":"interviewSchedule.create","operationId":"interviewScheduleCreate","description":"Create a scheduled interview in Ashby\n\n**Requires the [`interviewsWrite`](authentication#permissions-interviewschedulecreate) permission.**\n","tags":["Interview Schedule"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application for this interview schedule"}]},"interviewEvents":{"type":"array","description":"The list of events that make up this interview schedule","items":{"type":"object","required":["startTime","endTime","interviewers"],"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","description":"The interviewers for this event","items":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"The email address of the user in Ashby","example":"test@ashbyhq.com"},"feedbackRequired":{"type":"boolean","description":"Whether this interviewer is required to provide feedback"}}}},"extraData":{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/extraData"},"interviewId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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"}]}}}}},"required":["applicationId","interviewEvents"]}}}},"responses":{"200":{"description":"Responses from the interviewSchedule.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/interviewScheduleCreate/post/requestBody/content/application~1json/schema/properties/data/properties/interviewSchedule"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewSchedule.list":{"post":{"summary":"interviewSchedule.list","operationId":"interviewScheduleList","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.**\n","tags":["Interview Schedule"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application, for which to fetch interview schedules"}]},"interviewStageId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interview stage, for which to fetch interview schedules"}]}}}]}}}},"responses":{"200":{"description":"Responses from the interviewSchedule.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/webhooks/interviewScheduleCreate/post/requestBody/content/application~1json/schema/properties/data/properties/interviewSchedule"}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewSchedule.update":{"post":{"summary":"interviewSchedule.update","operationId":"interviewScheduleUpdate","description":"Update an interview schedule. This endpoint allows you to add, cancel, or update interview events associated with an interview schedule.\n\n**Requires the [`interviewsWrite`](authentication#permissions-interviewscheduleupdate) permission.**\n\nIn order to update an interview event on a schedule, the event's `interviewEventId` must be included when sending your request. \n`interviewEventId`s are included in the response of the `interviewSchedule.create` endpoint.\n","tags":["Interview Schedule"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interviewScheduleId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interview schedule to update.\nOnly interview schedules created using the API key making the request can be updated.\n"}]},"interviewEvent":{"description":"An event on the interview schedule to create or update.\nTo update an event, the event's `interviewEventId` must be included in the request.\n","oneOf":[{"$ref":"#/paths/~1interviewSchedule.create/post/requestBody/content/application~1json/schema/properties/interviewEvents/items"},{"type":"array","items":{"$ref":"#/paths/~1interviewSchedule.create/post/requestBody/content/application~1json/schema/properties/interviewEvents/items"}}],"properties":{"interviewEventId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of an interview event to update.\n"}]}}},"interviewEventIdToCancel":{"description":"The ids of interview events to cancel.\n","oneOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"type":"array","items":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}}]},"allowFeedbackDeletion":{"type":"boolean","default":false,"description":"By default, we do not allow interview events with submitted feedback to be canceled because canceling an event causes its associated feedback to be deleted. If you want to allow events with submitted feedback to be canceled, this flag can be passed in and set to `true`. In this case, events with feedback will be canceled, and any associated feedback will be deleted."}},"oneOf":[{"required":["interviewScheduleId","interviewEvent"]},{"required":["interviewScheduleId","interviewEventIdToCancel"]}]}}}},"responses":{"200":{"description":"Responses from the interviewSchedule.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/interviewScheduleCreate/post/requestBody/content/application~1json/schema/properties/data/properties/interviewSchedule"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"interviewStageList","tags":["Interview Stage"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interviewPlanId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interview plan to list stages for"}]}},"required":["interviewPlanId"]}}}},"responses":{"200":{"description":"Responses for the interviewStage.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1interviewStage.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"moreDataAvailable":{"$ref":"#/paths/~1source.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/moreDataAvailable"}},"required":["results","moreDataAvailable"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewStage.info":{"post":{"summary":"interviewStage.info","operationId":"interviewStageInfo","description":"Fetch interview stage details by id\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewstageinfo) permission.**\n","tags":["Interview Stage"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"interviewStageId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique id of the interview stage whose details will be fetched"}]}},"required":["interviewStageId"],"example":{"interviewStageId":"3ae2b801-19f6-41ef-ad28-214bd731948f"}}}}},"responses":{"200":{"description":"Responses from the interviewStage.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"allOf":[{"$ref":"#/paths/~1jobInterviewPlan.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/stages/items/allOf/0"},{"type":"object","properties":{"interviewPlanId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"required":["interviewPlanId"]}]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewStageGroup.list":{"post":{"summary":"interviewStageGroup.list","description":"List all interview group stages for an interview plan in order.\n\n**Requires the [`interviewsRead`](authentication#permissions-interviewstagelist) permission.**\n","operationId":"interviewStageGroupList","tags":["Interview Stage Group"],"responses":{"200":{"description":"Responses for the interviewStageGroup.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","example":"Technical Screening"},"order":{"type":"integer","example":1},"stageType":{"type":"string","enum":["Lead","PreInterviewScreen","Active","Offer","Hired","Archived"],"example":"Active"}},"required":["id","title","order","stageType"]}]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewerPool.list":{"post":{"summary":"interviewerPool.list","operationId":"interviewerPoolList","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.**\n","tags":["Interviewer Pool"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"includeArchivedPools":{"type":"boolean","description":"When true, includes archived pools","default":false},"includeArchivedTrainingStages":{"type":"boolean","description":"When true, includes archived training stages","default":false}}}]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"},{"description":"Whether or not the pool is archived"}]},"trainingPath":{"type":"object","properties":{"id":{"allOf":[{"description":"The training path's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"enabled":{"type":"boolean","description":"Whether or not the training path is enabled","example":true},"trainingStages":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"description":"The training stage's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"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":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["id","interviewerRole","interviewsRequired","isArchived","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewerPool.info":{"post":{"summary":"interviewerPool.info","operationId":"interviewerPoolInfo","description":"Get information about an interviewer pool.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-interviewerpoolinfo) permission.**\n","tags":["Interviewer Pool"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interviewerPoolId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"required":["interviewerPoolId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"allOf":[{"$ref":"#/paths/~1interviewerPool.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"},{"type":"object","properties":{"qualifiedMembers":{"type":"array","items":{"allOf":[{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},{"type":"object","description":"A user who is a qualified member of an interviewer pool.","properties":{"isPaused":{"type":"boolean","description":"Whether the user is currently paused from interviewing in this pool.","example":false}},"required":["isPaused"]}]}},"trainees":{"type":"array","items":{"allOf":[{"$ref":"#/paths/~1interviewerPool.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/allOf/1/properties/qualifiedMembers/items"},{"properties":{"currentProgress":{"type":"object","properties":{"trainingPathId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","description":"The id of the training path the user is currently on"},"trainingPathStageId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","description":"The id of the training stage the user is currently in"},"interviewsCompleted":{"type":"integer","description":"The number of interviews the user has completed in the current stage","example":1}},"required":["trainingPathId","trainingPathStageId","interviewsCompleted"]}}}],"required":["currentProgress"]}}}}]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewerPool.create":{"post":{"summary":"interviewerPool.create","operationId":"interviewerPoolCreate","description":"Create an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolcreate) permission.**\n","tags":["Interviewer Pool"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of the interviewer pool","example":"Engineering"},"requiresTraining":{"type":"boolean","description":"Whether the interviewer pool requires training","example":true}},"required":["title"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1interviewerPool.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewerPool.update":{"post":{"summary":"interviewerPool.update","operationId":"interviewerPoolUpdate","description":"Update an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolupdate) permission.**\n","tags":["Interviewer Pool"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interviewerPoolId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","description":"The title of the interviewer pool","example":"Engineering"},"requiresTraining":{"type":"boolean","description":"Whether the interviewer pool requires training","example":true}},"required":["interviewerPoolId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1interviewerPool.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewerPool.archive":{"post":{"summary":"interviewerPool.archive","operationId":"interviewerPoolArchive","description":"Archives an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolarchive) permission.**\n","tags":["Interviewer Pool"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interviewerPoolId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"required":["interviewerPoolId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.archive endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1interviewerPool.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewerPool.restore":{"post":{"summary":"interviewerPool.restore","operationId":"interviewerPool.restore","description":"Restores an archived interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolrestore) permission.**\n","tags":["Interviewer Pool"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interviewerPoolId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"required":["interviewerPoolId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.restore endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1interviewerPool.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewerPool.addUser":{"post":{"summary":"interviewerPool.addUser","operationId":"interviewerPoolAddUser","description":"Add a user to an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpooladduser) permission.**\n","tags":["Interviewer Pool"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interviewerPoolId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewerPoolTrainingPathStageId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","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."}},"required":["interviewerPoolId","userId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.removeUser endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1interviewerPool.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/interviewerPool.removeUser":{"post":{"summary":"interviewerPool.removeUser","operationId":"interviewerPoolRemoveUser","description":"Remove a user from an interviewer pool.\n\n**Requires the [`hiringProcessMetadataWrite`](authentication#permissions-interviewerpoolremoveuser) permission.**\n","tags":["Interviewer Pool"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"interviewerPoolId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"userId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"required":["interviewerPoolId","userId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.removeUser endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1interviewerPool.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/job.create":{"post":{"summary":"job.create","operationId":"jobCreate","description":"Creates a new job\n\n**Requires the [`jobsWrite`](authentication#permissions-jobcreate) permission.**\n\nTo set values for custom fields on Jobs, use the [`customFields.setValue`](ref:customfieldsetvalue) endpoint.\n","tags":["Job"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"Software Engineer","description":"The title of the job."},"teamId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"defaultInterviewPlanId":{"allOf":[{"description":"The id of the default interview plan for this job. \nA job cannot be opened without a default interview plan.\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"jobTemplateId":{"allOf":[{"description":"The id of the job template to use for this job.\nOnly active job templates can be used to create a job.\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["title","teamId","locationId"]}}}},"responses":{"200":{"description":"Responses for the job.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/job.info":{"post":{"summary":"job.info","operationId":"jobInfo","description":"Returns details about a single job by id\n\n**Requires the [`jobsRead`](authentication#permissions-jobinfo) permission.**\n","tags":["Job"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"description":"The id of the job to fetch"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"includeUnpublishedJobPostingsIds":{"type":"boolean","description":"Include unpublished job posting ids"},"expand":{"type":"array","description":"Choose to expand the result and include additional data for related objects. \n","items":{"type":"string","enum":["location","openings"]}}},"required":["id"]}}}},"responses":{"200":{"description":"Responses for the job.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"allOf":[{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job"},{"type":"object","properties":{"location":{"allOf":[{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},{"description":"The location will only be included if the `location` expand parameter is included when the request is made."}]},"openings":{"description":"The openings array will only be included if the `openings` expand parameter is included when the request is made.","type":"array","items":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"compensation":{"description":"The compensation object will only be included if the `compensation` expand parameter is included when the request is made.","type":"object","properties":{"compensationTiers":{"$ref":"#/paths/~1job.updateCompensation/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/allOf/0/properties/compensationTiers","description":"The compensation ranges that can be offered to applicants for this posting"}}}}}]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/job.list":{"post":{"summary":"job.list","description":"List all open, closed, and archived 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.**\n\nTo include draft jobs, `Draft` must be specified in the `status` param.\n","operationId":"jobList","tags":["Job"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"status":{"type":"array","description":"When supplied, only jobs with the provided status(es) will be returned.","items":{"$ref":"#/paths/~1job.setStatus/post/requestBody/content/application~1json/schema/properties/status/allOf/1"}},"openedAfter":{"type":"integer","format":"int64","description":"Return jobs opened after this date, which is the time since the unix epoch in milliseconds"},"openedBefore":{"type":"integer","format":"int64","description":"Return jobs opened before this date, which is the time since the unix epoch in milliseconds"},"closedAfter":{"type":"integer","format":"int64","description":"Return jobs closed after this date, which is the time since the unix epoch in milliseconds"},"closedBefore":{"type":"integer","format":"int64","description":"Return jobs closed before this date, which is the time since the unix epoch in milliseconds"},"includeUnpublishedJobPostingsIds":{"type":"boolean","description":"Include unpublished job posting ids"},"expand":{"$ref":"#/paths/~1job.info/post/requestBody/content/application~1json/schema/properties/expand"}}}]}}}},"responses":{"200":{"description":"Responses for the jobPosting.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"allOf":[{"$ref":"#/paths/~1brand.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"syncToken":{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema/properties/syncToken"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job"},{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/allOf/1"}]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/job.setStatus":{"post":{"summary":"job.setStatus","operationId":"jobSetStatus","description":"Sets the status on a job by id.\n\n**Requires the [`jobsWrite`](authentication#permissions-jobsetstatus) permission.**\n\nAll jobs are drafts when they're first created. There are a few validations around the stages a job can be transitioned to:\n- Drafts can be changed to Open or Archived\n- Open jobs can be changed to Closed\n- Closed jobs can be changed to Draft or Archived\n- Archived jobs can be changed to a Draft \n","tags":["Job"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"allOf":[{"description":"The unique id of the job to set the status of."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"status":{"allOf":[{"description":"The status to apply to the job."},{"type":"string","enum":["Draft","Open","Closed","Archived"]}]}},"required":["jobId","status"]}}}},"responses":{"200":{"description":"Responses for the job.setStatus endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/job.update":{"post":{"summary":"job.update","operationId":"jobUpdate","description":"Updates an existing job\n\n**Requires the [`jobsWrite`](authentication#permissions-jobupdate) permission.**\n\nTo set values for custom fields on Jobs, use the [`customFields.setValue`](ref:customfieldsetvalue) endpoint.\n","tags":["Job"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"allOf":[{"description":"The unique id of the job to update."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"title":{"type":"string","example":"Software Engineer","description":"A new title for the job."},"teamId":{"allOf":[{"description":"The new team to associate with the job."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"locationId":{"allOf":[{"description":"The new location to associate with the job."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"defaultInterviewPlanId":{"allOf":[{"description":"The new default interview plan to associate with the job."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"customRequisitionId":{"allOf":[{"description":"The new default custom requisition id for the job."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["jobId"]}}}},"responses":{"200":{"description":"Responses for the job.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/job.updateCompensation":{"post":{"summary":"job.updateCompensation","operationId":"jobUpdateCompensation","description":"Updates an existing job's compensation tiers\n\n**Requires the [`jobsWrite`](authentication#permissions-jobupdate) permission.**\n","tags":["Job"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"allOf":[{"description":"The unique id of the job to update."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"compensationTiers":{"type":"array","items":{"type":"object","description":"A valid compensation range that can be offered to candidates","properties":{"title":{"type":"string","example":"Zone A","description":"A label that describes the entire range to applicants. Title is required for multi-tier compensation ranges."},"additionalInformation":{"type":"string","example":"Signing bonus available","description":"Supplementary information about the compensation"},"components":{"type":"array","description":"The individual components that make up this compensation range","items":{"allOf":[{"type":"object","properties":{"compensationType":{"type":"string","enum":["Salary","EquityPercentage","EquityCashValue","Commission","Bonus"],"example":"Salary","description":"The type of compensation this component represents\n"},"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","description":"The frequency at which this compensation is given"},"currencyCode":{"type":"string","example":"EUR","description":"For non `EquityPercentage` components, the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)\ncurrency code of the compensation range\n"},"label":{"type":"string","example":"Estimated Salary","description":"An optional label that describes this compensation range to applicants"},"minValue":{"oneOf":[{"type":"number"},{"type":"null"}],"example":72000.1,"description":"The lower end of the compensation range"},"maxValue":{"oneOf":[{"type":"number"},{"type":"null"}],"example":100000,"description":"The higher end of the compensation range"}},"required":["compensationType","interval"]},{"type":"object","required":["minValue","maxValue"]}]},"example":[{"compensationType":"Salary","interval":"1 YEAR","currencyCode":"EUR","minValue":72023.45,"maxValue":100000},{"compensationType":"EquityPercentage","interval":"NONE","minValue":1,"maxValue":2.511},{"compensationType":"Bonus","interval":"1 YEAR","minValue":null,"maxValue":null}]}},"required":["components"]}}},"required":["jobId","compensationTiers"]}}}},"responses":{"200":{"description":"Responses for the job.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"description":"Job with updated compensation tiers","allOf":[{"type":"object","properties":{"compensationTiers":{"description":"The compensation ranges that can be offered to applicants for this posting","type":"array","items":{"type":"object","description":"A compensation range that can be offered to candidates","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The compensation tier's unique id"}]},"title":{"type":"string","example":"Zone A","description":"A label that describes the entire range to applicants"},"additionalInformation":{"type":"string","example":"Signing bonus available","description":"Supplementary information about the compensation"},"components":{"type":"array","items":{"type":"object","description":"A part of a compensation tier that represents one specific type of compensation, e.g. the \"Salary\"\nor the \"Bonus.\"\n","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The component's unique id"}]}},"allOf":[{"$ref":"#/paths/~1jobPosting.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/compensation/properties/summaryComponents/items"}],"required":["id"]},"description":"The individual components that make up this compensation range","example":[{"id":"fb8efeaa-bea1-4713-9012-cbd25fc3dc89","summary":"€72K – €100K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"EUR","minValue":72023.45,"maxValue":100000},{"id":"93c62578-ed5d-42dd-8186-64ad5ba5603d","summary":"1% – 2.511%","compensationType":"EquityPercentage","interval":"NONE","minValue":1,"maxValue":2.511},{"id":"fb8efeaa-bea1-4713-9012-cbd25fc3dc90","summary":"Offers Bonus","compensationType":"Bonus","interval":"1 YEAR","minValue":null,"maxValue":null}]},"tierSummary":{"type":"string","example":"€72K – €100K • 1% – 2.511% • Offers Bonus","description":"A summary of the tiers's components in the same format shown on Ashby-hosted Job Boards\n"}},"required":["id","components","tierSummary"]},"example":[{"id":"da53719f-a115-400b-9d30-9b875428f1e7","title":"Zone A","components":[{"id":"fb8efeaa-bea1-4713-9012-cbd25fc3dc89","summary":"€72K – €100K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"EUR","minValue":72023.45,"maxValue":100000},{"id":"93c62578-ed5d-42dd-8186-64ad5ba5603d","summary":"1% – 1.4%","compensationType":"EquityPercentage","interval":"NONE","minValue":1,"maxValue":1.4}],"tierSummary":"€72K – €100K • 1% – 1.4%"},{"id":"81362ab1-739e-44f5-88d9-dbc5c731624c","title":"Zone B","additionalInformation":"Commuter Benefits","components":[{"id":"fb8efeaa-bea1-4713-9012-cbd25fc3dc89","summary":"€72K – €100K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"EUR","minValue":95010.12,"maxValue":270450},{"id":"93c62578-ed5d-42dd-8186-64ad5ba5603d","summary":"1.8% – 2.511%","compensationType":"EquityPercentage","interval":"NONE","minValue":1.8,"maxValue":2.511},{"id":"5eb15197-8664-48fd-99cf-fbdc9d25149d","summary":"Offers Bonus","compensationType":"Bonus","interval":"1 YEAR","minValue":null,"maxValue":null}],"tierSummary":"€95K – €270K • 1.8% – 2.511% • Offers Bonus • Commuter Benefits"}]}},"required":["compensationTiers"]},{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job"}]}}},{"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/job.search":{"post":{"summary":"job.search","operationId":"jobSearch","description":"Searches for jobs by title\n\n**Requires the [`jobsRead`](authentication#permissions-jobsearch) permission.**\n","tags":["Job"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"Software Engineer","description":"The title of the job to search for"},"requisitionId":{"type":"string","example":"REQ-2471","description":"The requisition ID of the job to search for"}},"anyOf":[{"required":["title"]},{"required":["requisitionId"]}]}}}},"responses":{"200":{"description":"Responses for the job.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job"}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/jobBoard.list":{"post":{"summary":"jobBoard.list","description":"List all enabled job boards.\n\n**Requires the [`jobsRead`](authentication#permissions-jobboardlist) permission.**\n","operationId":"jobBoardList","tags":["Job Board"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Responses for the jobBoard.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string"},"isInternal":{"type":"boolean","description":"Whether the job board is an internal board."}},"required":["id","title","isInternal"]}]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/jobInterviewPlan.info":{"post":{"summary":"jobInterviewPlan.info","operationId":"jobInterviewPlanInfo","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.**\n","tags":["Job Interview Plan"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"allOf":[{"description":"The id of the job to fetch an interview plan for"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["jobId"]}}}},"responses":{"200":{"description":"Responses for the jobInterviewPlan.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"jobId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"interviewPlanId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"stages":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"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"]},{"type":"object","properties":{"activities":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","example":"Onsite Schedule"},"interviews":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"title":{"type":"string","example":"System Architecture"},"interviewId":{"allOf":[{"description":"The id of the interview to be scheduled"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"interviewDurationMinutes":{"type":"number","example":30},"isSchedulable":{"type":"boolean","example":true}}}}},"required":["id","interviews"]}}},"required":["activities"]}]}}},"description":"A plan for conducting job interviews.","required":["jobId","interviewPlanId","stages"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/jobPosting.info":{"post":{"summary":"jobPosting.info","description":"Retrieve an individual job posting\n\n**Requires the [`jobsRead`](authentication#permissions-jobpostinginfo) permission.**\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` -\tSee the guide on [Creating a custom careers page](https://developers.ashbyhq.com/docs/creating-a-custom-careers-page).\n","operationId":"jobPostingInfo","tags":["Job Posting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"jobPostingId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the job posting to return"}]},"jobBoardId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"If provided, returns the job posting data for the specified job board. If omitted, defaults to an external job board."}]},"expand":{"type":"array","description":"Choose to expand the result and include additional data for related objects. \n","items":{"type":"string","enum":["job"]}}},"required":["jobPostingId"]}}}},"responses":{"200":{"description":"Responses for the jobPosting.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The job posting's id"}]},"title":{"type":"string","description":"The job posting's title","example":"Posting Title"},"descriptionPlain":{"type":"string","description":"A plaintext version of the job posting's description","example":"This example role will be part of an example team and will report to the example manager. The new hire plays a critical role in various example workflows.\n\n\n\nREQUIREMENTS\n\n - Experience writing good example job descriptions\n\n - Other exemplary skills\n\n - 3-5 years prior experience in this role\n\n - Motivation\n\n - Great english language skills\n   \n\n\nABOUT THE TEAM\n\n\nExample org is a leading software company. Example org allows real-time collaboration on important example workflows. Founded in 2012 we have over 10,000 customers worldwide and are backed by fantastic investors such as Sequoia Capital.\n\n"},"descriptionHtml":{"type":"string","description":"An HTML version of the job posting's description","example":"<p style=\"min-height:1.5em\">This example role will be part of an example team and will report to the example manager. The new hire plays a critical role in various example workflows.</p><h1><br />Requirements</h1><ul style=\"min-height:1.5em\"><li><p style=\"min-height:1.5em\">Experience writing good example job descriptions</p></li><li><p style=\"min-height:1.5em\">Other exemplary skills</p></li><li><p style=\"min-height:1.5em\">3-5 years prior experience in this role</p></li><li><p style=\"min-height:1.5em\">Motivation</p></li><li><p style=\"min-height:1.5em\">Great english language skills<br /></p></li></ul><h1>About the Team</h1><p style=\"min-height:1.5em\"><br />Example org is a leading software company. Example org allows real-time collaboration on important example workflows. Founded in 2012 we have over 10,000 customers worldwide and are backed by fantastic investors such as Sequoia Capital.</p><p style=\"min-height:1.5em\"></p>"},"descriptionSocial":{"type":"string","description":"A shortened job posting description displayed when shared on social media, limited to 200 characters.","example":"Example org allows real-time collaboration on important example workflows. When you join as an example role, part of the example team, you will perform a critical role in various example workflows."},"descriptionParts":{"type":"object","description":"The above description broken down into the actual description on the job, and the Job Post Description Opening and Closing that is set by the admin in Ashby's Job Boards → Theme → Messaging settings.","properties":{"descriptionOpening":{"allOf":[{"$ref":"#/paths/~1jobPosting.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/descriptionParts/properties/descriptionBody/allOf/0"},{"description":"The content set in the Job Post Description Opening theme settings"},{"properties":{"html":{"description":"An HTML version of the Job Post Description Opening theme settings","example":null},"plain":{"description":"A plaintext version of the Job Post Description Opening theme settings","example":null}}}]},"descriptionBody":{"allOf":[{"type":"object","properties":{"html":{"type":"string"},"plain":{"type":"string"}},"required":["html","plain"]},{"description":"The description set on the job posting"},{"properties":{"html":{"description":"An HTML version of the description set on the job posting","example":"<p style=\"min-height:1.5em\">This example role will be part of an example team and will report to the example manager. The new hire plays a critical role in various example workflows.</p><h1><br />Requirements</h1><ul style=\"min-height:1.5em\"><li><p style=\"min-height:1.5em\">Experience writing good example job descriptions</p></li><li><p style=\"min-height:1.5em\">Other exemplary skills</p></li><li><p style=\"min-height:1.5em\">3-5 years prior experience in this role</p></li><li><p style=\"min-height:1.5em\">Motivation</p></li><li><p style=\"min-height:1.5em\">Great english language skills<br /></p></li></ul></p>"},"plain":{"description":"An plaintext version of the description set on the job posting","example":"This example role will be part of an example team and will report to the example manager. The new hire plays a critical role in various example workflows.\\n\\n\\n\\nREQUIREMENTS\\n\\n - Experience writing good example job descriptions\\n\\n - Other exemplary skills\\n\\n - 3-5 years prior experience in this role\\n\\n - Motivation\\n\\n - Great english language skills\\n"}}}]},"descriptionClosing":{"allOf":[{"$ref":"#/paths/~1jobPosting.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/descriptionParts/properties/descriptionBody/allOf/0"},{"description":"The content set in the Job Post Description Closing theme settings"},{"properties":{"html":{"description":"An HTML version of the Job Post Description Closing theme settings","example":"<h1>About the Team</h1><p style=\"min-height:1.5em\"><br />Example org is a leading software company. Example org allows real-time collaboration on important example workflows. Founded in 2012 we have over 10,000 customers worldwide and are backed by fantastic investors such as Sequoia Capital.</p>"},"plain":{"description":"A plaintext version of the Job Post Description Closing theme settings","example":"ABOUT THE TEAM\\n\\n\\nExample org is a leading software company. Example org allows real-time collaboration on important example workflows. Founded in 2012 we have over 10,000 customers worldwide and are backed by fantastic investors such as Sequoia Capital.\\n\\n"}}}]}}},"departmentName":{"type":"string","example":"People","description":"The name of the department associated with the job posting"},"teamName":{"type":"string","example":"Recruiting Operations","description":"The name of the team associated with the job posting"},"teamNameHierarchy":{"type":"array","items":{"type":"string"},"example":["People","Recruiting","Recruiting Operations"],"description":"The hierarchy of team names associated with the job posting."},"jobId":{"allOf":[{"description":"The id of the job associated with the job posting"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"locationName":{"type":"string","example":"Springfield","description":"The name of the primary location associated with the job posting"},"locationIds":{"$ref":"#/webhooks/jobPostingUpdate/post/requestBody/content/application~1json/schema/properties/data/properties/jobPosting/properties/locationIds"},"linkedData":{"type":"object","description":"An object that can be used to populate \"rich results\" in search engines. (https://developers.google.com/search/docs/data-types/job-posting)","properties":{"@context":{"type":"string","example":"https://schema.org/"},"@type":{"type":"string","example":"JobPosting"},"title":{"type":"string","example":"Posting Title"},"description":{"type":"string","example":"<p style=\"min-height:1.5em\">This example role will be part of an example team and will report to the example manager. The new hire plays a critical role in various example workflows.</p><h1><br />Requirements</h1><ul style=\"min-height:1.5em\"><li><p style=\"min-height:1.5em\">Experience writing good example job descriptions</p></li><li><p style=\"min-height:1.5em\">Other exemplary skills</p></li><li><p style=\"min-height:1.5em\">3-5 years prior experience in this role</p></li><li><p style=\"min-height:1.5em\">Motivation</p></li><li><p style=\"min-height:1.5em\">Great english language skills<br /></p></li></ul><h1>About the Team</h1><p style=\"min-height:1.5em\"><br />Example org is a leading software company. Example org allows real-time collaboration on important example workflows. Founded in 2012 we have over 10,000 customers worldwide and are backed by fantastic investors such as Sequoia Capital.</p><p style=\"min-height:1.5em\"></p>"},"identifier":{"type":"object","properties":{"@type":{"type":"string","example":"PropertyValue"},"name":{"type":"string","example":"Posting Title"},"value":{"type":"string","example":"4be0e8c0-9323-43a0-ab48-506789ab9c16"}}},"datePosted":{"type":"string","example":"2022-07-22"},"hiringOrganization":{"type":"object","properties":{"@type":{"type":"string","example":"Organization"},"name":{"type":"string","example":"Example org"},"sameAs":{"type":"string","example":"34d7c77d-e9b2-5a09-a882-cb23a225f2ec.com"}}},"jobLocation":{"type":"object","properties":{"@type":{"type":"string","example":"Place"},"address":{"type":"object","properties":{"@type":{"type":"string","example":"PostalAddress"}}}}},"employmentType":{"type":"string","enum":["FULL_TIME","PART_TIME","CONTRACTOR","TEMPORARY","INTERN"],"example":"FULL_TIME"}}},"publishedDate":{"type":"string","example":"2022-07-22","description":"The date the job posting was published"},"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"},"address":{"allOf":[{"description":"The address of the job posting"},{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/address"}]},"isRemote":{"description":"Whether or not the job posting location is remote","type":"boolean"},"workplaceType":{"allOf":[{"description":"The type of workplace."},{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/workplaceType/allOf/1"}]},"employmentType":{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job/properties/employmentType"},"applicationFormDefinition":{"allOf":[{"$ref":"#/paths/~1offer.start/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/formDefinition"},{"description":"See the guide on [Creating a Custom Careers Page](https://developers.ashbyhq.com/docs/creating-a-custom-careers-page)"}]},"surveyFormDefinitions":{"type":"array","items":{"$ref":"#/paths/~1surveyFormDefinition.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"description":"Additional survey forms to be collected alongside the application form. See the guide on [Creating a Custom Careers Page](https://developers.ashbyhq.com/docs/creating-a-custom-careers-page)"},"isListed":{"type":"boolean","example":true,"description":"Whether or not the job posting is listed"},"suppressDescriptionOpening":{"type":"boolean","example":true,"description":"When true, the job description opening from the brand will be suppressed. descriptionOpening will be returned as null."},"suppressDescriptionClosing":{"type":"boolean","example":true,"description":"When true, the job description closing from the brand will be suppressed. descriptionClosing will be returned as null."},"externalLink":{"type":"string","example":"https://jobs.ashbyhq.com/70b51cc4-7f34-5567-92bd-96f354f7439a/4be0e8c0-9323-43a0-ab48-506789ab9c16","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."},"compensation":{"type":"object","description":"Compensation ranges associated with the job posting and related settings","required":["compensationTiers","shouldDisplayCompensationOnJobBoard"],"properties":{"compensationTierSummary":{"type":"string","example":"$72K – $270K • 1% – 2.25% • Offers Bonus • Multiple Ranges","description":"A summary of *all* the job posting's valid `compensationTiers` in the same format shown on\nAshby-hosted Job Boards\n"},"summaryComponents":{"type":"array","items":{"allOf":[{"$ref":"#/paths/~1job.updateCompensation/post/requestBody/content/application~1json/schema/properties/compensationTiers/items/properties/components/items/allOf/0"},{"type":"object","description":"A part of a compensation tier that represents one specific type of compensation, e.g. the \"Salary\"\nor the \"Bonus.\"\n","properties":{"summary":{"type":"string","example":"€72K – €100K","description":"The summary of this component in the same format shown on Ashby-hosted Job Boards"}},"required":["summary"]}]},"description":"The maximum and minimum compensation ranges across *all* the posting's `compensationTiers`\nthat make up `compensationTierSummary`\n","example":[{"summary":"€72K – €270K","compensationType":"Salary","interval":"1 YEAR","currencyCode":"EUR","minValue":72023.45,"maxValue":270450},{"summary":"1% – 2.25%","compensationType":"EquityPercentage","interval":"NONE","minValue":1,"maxValue":2.25},{"summary":"Offers Bonus","compensationType":"Bonus","interval":"1 YEAR","minValue":null,"maxValue":null}]},"compensationTiers":{"$ref":"#/paths/~1job.updateCompensation/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/allOf/0/properties/compensationTiers","description":"The compensation ranges that can be offered to applicants for this posting"},"shouldDisplayCompensationOnJobBoard":{"type":"boolean","example":true,"description":"Whether the job posting's settings specify that compensation should be shown to applicants\n"}}},"updatedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"applicationLimitCalloutHtml":{"type":"string","description":"An HTML version of any communication you would like to show to applicants about the application limit for this job posting","example":"<div>\n  <p>Please Note: we have set up limits for applications for this role. It is in the <strong>Product Limit </strong> group. The following limits apply to applications for all jobs within this group:</p>\n  <ul>\n    <li>\n      <p>Candidates may not apply more than 1 time in any 60 day span for any job in the <strong>Product Limit </strong> Group.</p>\n    </li>\n  </ul>\n</div>\n"}},"required":["id","title","descriptionPlain","descriptionHtml","descriptionParts","departmentName","teamName","jobId","locationName","locationIds","linkedData","publishedDate","employmentType","applicationFormDefinition","surveyFormDefinitions","isListed","applyLink","compensation","updatedAt"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/jobPosting.list":{"post":{"summary":"jobPosting.list","description":"Lists all published job postings\n\n**Requires the [`jobsRead`](authentication#permissions-jobpostinglist) permission.**\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","operationId":"jobPostingList","tags":["Job Posting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"location":{"type":"string","description":"filter by location name (case sensitive)"},"department":{"type":"string","description":"filter by department name (case sensitive)"},"listedOnly":{"type":"boolean","description":"If true, filter out unlisted job postings.","default":false},"jobBoardId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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."}]}}}}}},"responses":{"200":{"description":"Responses for the jobPosting.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/webhooks/jobPostingUpdate/post/requestBody/content/application~1json/schema/properties/data/properties/jobPosting"}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"jobTemplateList","tags":["Job Template"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"expand":{"type":"array","description":"Choose to expand the result and include additional data for related objects. \n","items":{"type":"string","enum":["location"]}}}}]}}}},"responses":{"200":{"description":"Responses for the jobTemplate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string"},"status":{"type":"string","enum":["Active","Inactive"]},"locationId":{"allOf":[{"description":"The id of the location of the job template"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job template"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"defaultInterviewPlanId":{"allOf":[{"description":"The id of the default interview plan for this job template. \nA job cannot be opened without a default interview plan.\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ids of all interview plans associated with a job template"}]}},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"updatedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}},"required":["id","title","status"]},{"type":"object","properties":{"location":{"allOf":[{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},{"description":"The location will only be included if the `location` expand parameter is included when the request is made."}]}}}]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/jobPosting.update":{"post":{"summary":"jobPosting.update","operationId":"jobPostingUpdate","description":"Updates an existing job posting.\n\n**Requires the [`jobsWrite`](authentication#permissions-jobpostingupdate) permission.**\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","tags":["Job Posting"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"jobPostingId":{"allOf":[{"description":"The unique id of the job posting to update."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"title":{"type":"string","example":"Software Engineer","description":"A new title for the job posting."},"workplaceType":{"allOf":[{"description":"The type of workplace. LocationHierarchies cannot be labeled with a workplaceType."},{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/workplaceType/allOf/1"}]},"suppressDescriptionOpening":{"type":"boolean","example":true,"description":"When true, the job description opening from the brand will be suppressed. descriptionOpening will be returned as null."},"suppressDescriptionClosing":{"type":"boolean","example":true,"description":"When true, the job description closing from the brand will be suppressed. descriptionClosing will be returned as null."},"description":{"type":"object","description":"An HTML block of the job posting description. Please see below for supported tags.\n\n**Note**: 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","properties":{"type":{"type":"string","enum":["text/html"]},"content":{"type":"string","description":"The HTML content of the Job Posting. The following tags will accept updates. Updates to any other tags will be stripped out or not applied. \n- Headings - `<h[1-6]>`\n- Bold - `<b>`\n- Italic - `<i>`\n- Underline - `<u>`\n- Links - `<a>`\n- Bulleted Lists - `<ul>`, `<li>`\n- Ordered Lists - `<ol>`, `<li>`\n- Code - `<code>`\n- Code blocks - `<pre>`\n"}},"required":["type","content"]}},"required":["jobPostingId"]}}}},"responses":{"200":{"description":"Responses for the jobPosting.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1jobPosting.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/location.archive":{"post":{"summary":"location.archive","description":"Archives a location or location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationarchive) permission.**\n","operationId":"locationarchive","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["locationId"],"properties":{"locationId":{"type":"string","description":"The id of the location"}}}}}},"responses":{"200":{"description":"Responses for the location.archive endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/location.create":{"post":{"summary":"location.create","description":"Creates a location or location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationcreate) permission.**\n","operationId":"locationcreate","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the location."},"type":{"type":"string","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.","enum":["Location","LocationHierarchy"]},"address":{"type":"object","description":"The address of the location.","properties":{"postalAddress":{"type":"object","properties":{"addressCountry":{"type":"string","description":"The country the location is in. Must be a valid country name or two-letter country code."},"addressRegion":{"type":"string","description":"The region the location is in (for instance, a state or province)."},"addressLocality":{"type":"string","description":"The city or town of the location."},"postalCode":{"type":"string","description":"The postal code of the address."},"streetAddress":{"type":"string","description":"The street address of the location."}}}}},"parentLocationId":{"type":"string","description":"The id of the location's parent."},"isRemote":{"type":"boolean","description":"Whether the location should be labeled as remote. LocationHierarchies cannot be labeled as remote.","default":false},"workplaceType":{"allOf":[{"description":"The type of workplace. LocationHierarchies cannot be labeled with a workplaceType."},{"type":"string","enum":["OnSite","Hybrid","Remote"]}]},"externalName":{"type":"string","description":"An alternate candidate-facing name for this location used on job boards and in the API."},"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"}}}}}}},"responses":{"200":{"description":"Responses for the location.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/location.info":{"post":{"summary":"location.info","description":"Gets details for a single location by id.\n\n**Requires the [`organizationRead`](authentication#permissions-locationinfo) permission.**\n","operationId":"locationInfo","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the location to fetch"}]}},"required":["locationId"]}}}},"responses":{"200":{"description":"Responses for the location.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"name":{"type":"string","example":"Bay Area Office"},"externalName":{"type":"string","example":"San Francisco Office","description":"An alternate candidate-facing name for this location used on job boards and in the API"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"},"address":{"type":"object","properties":{"postalAddress":{"type":"object","properties":{"addressCountry":{"type":"string","example":"United States"},"addressRegion":{"type":"string","example":"California"},"addressLocality":{"type":"string","example":"San Francisco"},"postalCode":{"type":"string","example":"94108"},"streetAddress":{"type":"string","example":"49 Geary St Suite 411"}}}}},"isRemote":{"type":"boolean","example":false,"deprecated":true,"description":"Use `workplaceType` instead"},"workplaceType":{"description":"The type of workplace.","example":"Hybrid","$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/workplaceType/allOf/1"},"parentLocationId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"type":{"type":"string","enum":["Location","LocationHierarchy"],"description":"The type of the location component.","example":"Location"},"extraData":{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/extraData"}},"required":["id","name","isArchived"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"locationlist","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"},{"type":"object","additionalProperties":false,"properties":{"includeArchived":{"$ref":"#/paths/~1source.list/post/requestBody/content/application~1json/schema/properties/includeArchived"},"includeLocationHierarchy":{"type":"boolean","description":"If true, the response will include the location hierarchy (regions).\n","default":false,"example":false}}}]}}}},"responses":{"200":{"description":"Responses for the location.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/location.move":{"post":{"summary":"location.move","description":"Moves a location in location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationmove) permission.**\n","operationId":"locationmove","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["locationId","parentLocationHierarchyId"],"properties":{"locationId":{"type":"string","description":"The id of the location"},"parentLocationHierarchyId":{"type":"string","description":"The id of the parent location hierarchy"}}}}}},"responses":{"200":{"description":"Responses for the location.move endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/location.restore":{"post":{"summary":"location.restore","description":"Restores an archived location or location hierarchy.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationrestore) permission.**\n","operationId":"locationrestore","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["locationId"],"properties":{"locationId":{"type":"string","description":"The id of the location"}}}}}},"responses":{"200":{"description":"Responses for the location.restore endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"locationupdateaddress","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["locationId","address"],"properties":{"locationId":{"type":"string","description":"The id of the location"},"address":{"type":"object","description":"The address of the location","properties":{"postalAddress":{"type":"object","properties":{"addressCountry":{"type":"string","description":"The country of the location. Must be a valid country name or two-letter country code."},"addressRegion":{"type":"string","description":"The region of the location (for instance, a state or province)."},"addressLocality":{"type":"string","description":"The city or town of the location."},"postalCode":{"type":"string","description":"The postal code of the location."},"streetAddress":{"type":"string","description":"The street address of the location."}}}}}}}}}},"responses":{"200":{"description":"Responses for the location.updateAddress endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/location.updateName":{"post":{"summary":"location.updateName","description":"Update location's name.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationupdateName) permission.**\n","operationId":"locationupdateName","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["locationId","name"],"properties":{"locationId":{"type":"string","description":"The id of the location"},"name":{"type":"string","description":"The name of the location"}}}}}},"responses":{"200":{"description":"Responses for the location.updateName endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/location.updateExternalName":{"post":{"summary":"location.updateExternalName","description":"Update a location's external (candidate-facing) name.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationupdateexternalname) permission.**\n","operationId":"locationupdateexternalname","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["locationId"],"properties":{"locationId":{"type":"string","description":"The id of the location"},"externalName":{"type":"string","description":"An alternate candidate-facing name for this location used on job boards and in the API. Pass `null` to clear."}}}}}},"responses":{"200":{"description":"Responses for the location.updateExternalName endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/location.updateWorkplaceType":{"post":{"summary":"location.updateWorkplaceType","description":"Update location's workplace type.\n\n**Requires the [`organizationWrite`](authentication#permissions-locationupdateworkplacetype) permission.**\n","operationId":"locationupdateworkplacetype","tags":["Location"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["locationId","workplaceType"],"properties":{"locationId":{"type":"string","description":"The id of the location"},"workplaceType":{"allOf":[{"description":"The type of workplace. LocationHierarchies cannot be labeled with a workplaceType."},{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/workplaceType/allOf/1"}]}}}}}},"responses":{"200":{"description":"Responses for the location.updateWorkplaceType endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1location.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/notetakerTranscript.info":{"post":{"summary":"notetakerTranscript.info","operationId":"notetakerTranscriptInfo","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\n**Requires the [`notetakerRead`](authentication#permissions-notetakertranscriptinfo) permission.**\n","tags":["Notetaker Transcript"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"notetakerTranscriptId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique id of the notetaker transcript to fetch"}]}},"required":["notetakerTranscriptId"]},"example":{"notetakerTranscriptId":"3ae2b801-19f6-41ef-ad28-214bd731948f"}}}},"responses":{"200":{"description":"Responses from the notetakerTranscript.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique id of the notetaker transcript recording"}]},"interviewEventId":{"description":"The id of the interview event this transcript is associated with","oneOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"type":"null"}]},"interviewScheduleId":{"description":"The id of the interview schedule this transcript is associated with","oneOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"type":"null"}]},"createdAt":{"allOf":[{"$ref":"#/paths/~1candidate.addEmailMessage/post/requestBody/content/application~1json/schema/properties/sentAt/allOf/0"},{"description":"The time the transcript recording was created"}],"type":"string"},"participants":{"type":"array","description":"The participants in the interview, resolved from the interview schedule. Includes interviewers and the candidate.","items":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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","example":"interviewer"},"name":{"type":"string","description":"The display name of the participant","example":"Jane Smith"},"email":{"type":["string","null"],"description":"The primary email address of the participant, or null if not available","example":"jane.smith@example.com"}},"required":["id","type","name","email"]}},"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.","example":"https://s3.amazonaws.com/..."}},"required":["id","interviewEventId","interviewScheduleId","createdAt","participants","transcriptUrl"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/offer.approve":{"post":{"summary":"offer.approve","operationId":"offerApprove","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\n**Requires the [`offersWrite`](authentication#permissions-offerapprove) permission.**\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","tags":["Offer"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"offerVersionId":{"allOf":[{"description":"The id of the offer version that needs approval. This can be obtained as the `entityId` from the `approval.list` endpoint."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"approvalStepId":{"allOf":[{"description":"The id of the specific approval step to approve. If provided, `userId` must also be provided.\nIf omitted, the entire offer approval process will be approved. This can be obtained from the `approval.list` endpoint.\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"userId":{"allOf":[{"description":"The id of the user approving the step. Required if `approvalStepId` is provided.\nMust be an approver for the specified approval step.\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["offerVersionId"]}}}},"responses":{"200":{"description":"Responses for the offer.approve endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/offerCreate/post/requestBody/content/application~1json/schema/properties/data/properties/offer"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/offer.create":{"post":{"summary":"offer.create","operationId":"offerCreate","description":"Creates a new Offer\n\n**Requires the [`offersWrite`](authentication#permissions-offercreate) permission.**\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","tags":["Offer"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"offerProcessId":{"allOf":[{"description":"The id of the offer process associated with the offer you're creating. \nThis value is the id included in the response of the `offerProcess.start` API.\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"offerFormId":{"allOf":[{"description":"The id of the form associated with the offer.\nThis value is the id included in the response of the `offer.start` API.\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"offerForm":{"type":"object","properties":{"fieldSubmissions":{"type":"array","items":{"properties":{"path":{"type":"string","description":"The form field's \"path\" value"},"value":{"type":"string","description":"This is often a primitive but the value depends on the type of field being submitted. See the description above for details on the values accepted in this field."}},"required":["path","value"]}}},"required":["fieldSubmissions"]}},"required":["offerProcessId","offerFormId","offerForm"]}}}},"responses":{"200":{"description":"Responses for the offer.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/offerCreate/post/requestBody/content/application~1json/schema/properties/data/properties/offer"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/offer.info":{"post":{"summary":"offer.info","operationId":"offerInfo","description":"Returns details about a single offer by id\n\n**Requires the [`offersRead`](authentication#permissions-offerinfo) permission.**\n","tags":["Offer"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"offerId":{"allOf":[{"description":"The id of the offer to fetch"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["offerId"]}}}},"responses":{"200":{"description":"Responses for the offer.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/offerCreate/post/requestBody/content/application~1json/schema/properties/data/properties/offer"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"offerList","tags":["Offer"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"offerStatus":{"type":"array","minItems":1,"description":"When supplied, only offers with provided offer-status(es) will be returned. Array must contain at least one value.","items":{"allOf":[{"type":"string","enum":["WaitingOnApprovalStart","WaitingOnOfferApproval","WaitingOnApprovalDefinition","WaitingOnCandidateResponse","CandidateRejected","CandidateAccepted","OfferCancelled"]},{"title":"OfferStatus"}]}},"acceptanceStatus":{"type":"array","minItems":1,"description":"When supplied, only offers with provided acceptance-status(es) will be returned. Array must contain at least one value.","items":{"allOf":[{"type":"string","enum":["Accepted","Declined","Pending","Created","Cancelled","WaitingOnResponse"]},{"title":"AcceptanceStatus"}]}},"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"If provided, only returns the offers for the application with the supplied id"}]},"approvalStatus":{"type":"array","minItems":1,"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.","items":{"type":"string","enum":["Approved","WaitingOnApprovals","Declined"]}}}}]}}}},"responses":{"200":{"description":"Responses for the offer.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"decidedAt":{"type":"string"},"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application associated with the offer"}]},"acceptanceStatus":{"allOf":[{"$ref":"#/paths/~1offer.list/post/requestBody/content/application~1json/schema/allOf/1/properties/acceptanceStatus/items/allOf/0"},{"title":"AcceptanceStatus"}]},"offerStatus":{"allOf":[{"title":"OfferStatus"},{"$ref":"#/paths/~1offer.list/post/requestBody/content/application~1json/schema/allOf/1/properties/offerStatus/items/allOf/0"}]},"latestVersion":{"$ref":"#/webhooks/offerCreate/post/requestBody/content/application~1json/schema/properties/data/properties/offer/allOf/1/properties/versions/items"}},"required":["id","applicationId","acceptanceStatus"]}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/offer.start":{"post":{"summary":"offer.start","operationId":"offerStart","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\n**Requires the [`offersWrite`](authentication#permissions-offerstart) permission.**\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","tags":["Offer"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"offerProcessId":{"allOf":[{"description":"The ID of the offer process to start. This value is the id included in the response of the `offerProcess.start` API."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["offerProcessId"]}}}},"responses":{"200":{"description":"Responses for the offer.start endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"formDefinition":{"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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"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"]}}}}}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/offer.startApprovalProcess":{"post":{"summary":"offer.startApprovalProcess","operationId":"offerStartApprovalProcess","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.**\n","tags":["Offer"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"offerVersionId":{"allOf":[{"description":"The id of the offer version whose approval process should be started."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"note":{"type":"string","description":"Optional note to attach to the approval request."}},"required":["offerVersionId"]}}}},"responses":{"200":{"description":"Responses for the offer.startApprovalProcess endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/offerCreate/post/requestBody/content/application~1json/schema/properties/data/properties/offer"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/offer.update":{"post":{"summary":"offer.update","operationId":"offerUpdate","description":"Updates an existing Offer\n\n**Requires the [`offersWrite`](authentication#permissions-offerupdate) permission.**\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","tags":["Offer"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"offerId":{"allOf":[{"description":"The id of the offer you're updating.\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"offerForm":{"$ref":"#/paths/~1offer.create/post/requestBody/content/application~1json/schema/properties/offerForm","description":"The form submission for the offer. Can be retrieved from `offer.info`."}},"required":["offerId","offerForm"]}}}},"responses":{"200":{"description":"Responses for the offer.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/offerCreate/post/requestBody/content/application~1json/schema/properties/data/properties/offer"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/offerProcess.start":{"post":{"summary":"offerProcess.start","operationId":"offerProcess.start","description":"Starts an offer process for a candidate.\n\n**Requires the [`offersWrite`](authentication#permissions-offerprocessstart) permission.**\n","tags":["Offer Process"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"allOf":[{"description":"The id of the application to start an offer process for"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["applicationId"]}}}},"responses":{"200":{"description":"Responses for the offerProcess.start endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"allOf":[{"description":"The id of the started offer process"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"applicationId":{"allOf":[{"description":"The id of the application the offer process was started for"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"status":{"description":"The status of the offer process","type":"string","enum":["WaitingOnOfferCreation","WaitingOnApprovalStart","WaitingOnOfferApproval","WaitingOnCandidateResponse","CandidateAccepted","CandidateRejected","OfferCancelled"]}},"required":["id","applicationId","status"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["openingId"],"properties":{"openingId":{"type":"string","description":"The id of the opening"}}}}}},"responses":{"200":{"description":"Responses for the opening.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"createdAfter":{"type":"integer","format":"int64","description":"The API will return data after this date, which is the time since the unix epoch in milliseconds"},"cursor":{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema/properties/cursor"},"syncToken":{"type":"string","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.\n","example":"jYnEBmjzR"},"limit":{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema/properties/limit"}},"example":{"createdAfter":1659979196538,"cursor":"qA","syncToken":"6W05prn4d","limit":25}}}}},"responses":{"200":{"description":"Responses for the opening.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","description":"The identifier of the opening you want to search for"}}}}}},"responses":{"200":{"description":"Responses for the opening.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/opening.create":{"post":{"summary":"opening.create","description":"Creates an opening.\n      \n**Requires the [`jobsWrite`](authentication#permissions-openingcreate) permission.**\n\nTo set values of custom fields on Openings, use the [`customFields.setValue`](ref:customfieldsetvalue) endpoint.","operationId":"openingcreate","tags":["Openings"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"jobIds,     targetHireDate,     targetStartDate,     isBackfill,     employmentType,"},"description":{"type":"string"},"teamId":{"type":"string","description":"The id of the department or team associated with the opening."},"locationIds":{"type":"array","description":"The ids of the locations associated with the opening.","items":{"type":"string"}},"jobIds":{"type":"array","description":"The ids of the jobs associated with the opening","items":{"type":"string"}},"targetHireDate":{"type":"string","description":"The date (in YYYY-MM-DD format) by which you intend to hire against this opening."},"targetStartDate":{"type":"string","description":"The date (in YYYY-MM-DD format) by which you intend someone hired against this opening will start employment."},"isBackfill":{"type":"boolean","description":"Whether this opening is intended to backfill a previous employee","default":false},"employmentType":{"type":"string","description":"The employment type for this opening","default":"FullTime","enum":["FullTime","PartTime","Intern","Contract","Temporary",""]},"openingState":{"type":"string","description":"The state the opening should be created in. Defaults to `Draft`. If not Draft, additional validation will be performed.","enum":["Draft","Approved","Open","Closed"]}}}}}},"responses":{"200":{"description":"Responses for the opening.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["openingId","jobId"],"properties":{"openingId":{"type":"string","description":"The id of the opening"},"jobId":{"type":"string","description":"The id of the job to add"}}}}}},"responses":{"200":{"description":"Responses for the opening.addJob endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["openingId","jobId"],"properties":{"openingId":{"type":"string","description":"The id of the opening"},"jobId":{"type":"string","description":"The id of the job to remove from the opening."}}}}}},"responses":{"200":{"description":"Responses for the opening.removeJob endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["openingId","locationId"],"properties":{"openingId":{"type":"string","description":"The id of the opening"},"locationId":{"type":"string","description":"The id of the location to add to the opening."}}}}}},"responses":{"200":{"description":"Responses for the opening.addLocation endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["openingId","locationId"],"properties":{"openingId":{"type":"string","description":"The id of the opening"},"locationId":{"type":"string","description":"The id of the location to remove from the opening."}}}}}},"responses":{"200":{"description":"Responses for the opening.removeLocation endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"openingId":{"type":"string","description":"The id of the opening you want to update"},"openingState":{"type":"string","description":"The new state you want to update the opening to","enum":["Draft","Approved","Open","Closed"]},"closeReasonId":{"type":"string","description":"The id of the close reason if you are setting the state to closed"}}}}}},"responses":{"200":{"description":"Responses for the opening.setOpeningState endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"openingId":{"type":"string","description":"The id of the opening you want to archive"},"archive":{"type":"boolean","description":"The new archived state you want to update the opening to"}}}}}},"responses":{"200":{"description":"Responses for the opening.setArchived endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/opening.update":{"post":{"summary":"opening.update","description":"Updates an opening.\n      \n**Requires the [`jobsWrite`](authentication#permissions-openingupdate) permission.**\n\nTo set values for custom fields on Openings, use the [`customFields.setValue`](ref:customfieldsetvalue) endpoint.","operationId":"openingupdate","tags":["Openings"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"openingId":{"type":"string","description":"The openingId of the opening you want to update."},"identifier":{"type":"string","description":"jobIds,     targetHireDate,     targetStartDate,     isBackfill,     employmentType,"},"description":{"type":"string"},"teamId":{"type":"string","description":"The id of the department or team associated with the opening."},"targetHireDate":{"type":"string","description":"The date (in YYYY-MM-DD format) by which you intend to hire against this opening."},"targetStartDate":{"type":"string","description":"The date (in YYYY-MM-DD format) by which you intend someone hired against this opening will start employment."},"isBackfill":{"type":"boolean","description":"Whether this opening is intended to backfill a previous employee","default":false},"employmentType":{"type":"string","description":"The employment type for this opening","default":"FullTime","enum":["FullTime","PartTime","Intern","Contract","Temporary",""]}}}}}},"responses":{"200":{"description":"Responses for the opening.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/project.info":{"post":{"summary":"project.info","description":"Retrieves an project by its UUID.\n      \n**Requires the [`jobsRead`](authentication#permissions-projectinfo) permission.**","operationId":"projectinfo","tags":["Project"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["projectId"],"properties":{"projectId":{"type":"string","description":"The id of the project"}}}}}},"responses":{"200":{"description":"Responses for the project.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","example":"Office Event"},"description":{"type":"string","example":"Folks invited to office for an event"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"},"confidential":{"type":"boolean","example":false},"authorId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"customFieldEntries":{"type":"array","description":"All custom field values associated with the project","items":{"$ref":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["id","title"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"Responses for the project.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1project.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/project.search":{"post":{"summary":"project.search","operationId":"projectSearch","description":"Search for projects by title. \n\n**Requires the [`candidatesRead`](authentication#permissions-projectsearch) permission.**\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 operate on a final small set of projects, like building a project autocomplete.\n","tags":["Project"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The project's title"}},"example":{"title":"My Project"}}}}},"responses":{"200":{"description":"Responses for the project.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1project.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/referral.create":{"post":{"summary":"referral.create","operationId":"referralCreate","description":"Creates a referral\n\n**Requires the [`candidatesWrite`](authentication#permissions-referralcreate) permission.**\n","tags":["Referral"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"allOf":[{"description":"The id of the referral form, from /referralForm.info"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"creditedToUserId":{"allOf":[{"description":"The id of the user submitting the referral"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"fieldSubmissions":{"type":"array","items":{"properties":{"path":{"type":"string","description":"The form field's \"path\" value"},"value":{"type":"string","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 }\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.\n"}},"required":["path","value"]}},"createdAt":{"allOf":[{"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.\n"},{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}]}},"required":["id","creditedToUserId","fieldSubmissions"]}}}},"responses":{"200":{"description":"Responses for the referral.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/referralForm.info":{"post":{"summary":"referralForm.info","operationId":"referralFormInfo","description":"Fetches the default referral form or creates a default referral form if none exists.\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-referralforminfo) permission.**\n","tags":["Referral Form"],"responses":{"200":{"description":"Responses for the referral.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"allOf":[{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"organizationId":{"type":"string","format":"uuid","description":"The ID of the organization this form belongs to"},"title":{"type":"string","description":"The title of the form"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"},"isDefaultForm":{"type":"boolean","description":"Whether this is the default form for the organization"},"formDefinition":{"$ref":"#/paths/~1offer.start/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/formDefinition"}},"required":["id","organizationId","title","isArchived","isDefaultForm","formDefinition"]},{"type":"object","properties":{"organizationId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"isDefaultForm":{"type":"boolean","example":true}}}]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/report.generate":{"post":{"summary":"report.generate","operationId":"reportGenerate","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 → returns `requestId`\n2. Poll with both `reportId` and `requestId` every second until `status` is `complete` or `failed`\n\n**Example:**\n```\n// Step 1: Start generation\nPOST /report.generate\n{ \"reportId\": \"abc-123-def-456\" }\n→ { \"requestId\": \"rep_result:12345abc\", \"status\": \"in_progress\", \"reportData\": null }\n\n// Step 2: Poll for results\nPOST /report.generate\n{ \"reportId\": \"abc-123-def-456\", \"requestId\": \"rep_result:12345abc\" }\n→ { \"requestId\": \"rep_result:12345abc\", \"status\": \"complete\", \"reportData\": {...} }\n```\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`](ref:reportsynchronous))\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`](ref:reportsynchronous)\n- For synchronous retrieval of existing data, use [`report.synchronous`](ref:reportsynchronous)\n- Use this async endpoint for reports that may exceed 30 seconds\n\n**Requires the [`reportsRead`](authentication#permissions-reportgenerate) permission.**\n","tags":["Report"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1report.synchronous/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"requestId":{"type":"string","description":"Request ID for polling existing report generation status (optional - only used when polling)"}}}]},"examples":{"start_generation":{"summary":"Standard report request","value":{"reportId":"f9e52a51-a075-4116-a7b8-484deba69004"}},"start_generation_no_headers":{"$ref":"#/paths/~1report.synchronous/post/requestBody/content/application~1json/examples/no_headers_request"},"poll_generation":{"summary":"Poll generation status","value":{"reportId":"f9e52a51-a075-4116-a7b8-484deba69004","requestId":"rep_result:12345abc"}}}}}},"responses":{"200":{"description":"Responses for the report.generate endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"requestId":{"type":"string","description":"Unique identifier for this report generation request"},"status":{"type":"string","enum":["complete","failed","in_progress"],"description":"Current status of the report generation"},"reportData":{"anyOf":[{"type":"object","properties":{"data":{"type":"array","items":{"type":"array","items":{"oneOf":[{"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","description":"When the report data was last updated"},"title":{"type":"string","description":"Report title"},"reportGeneratedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp indicating when the report data was generated. Only present when status is complete."},"cacheExpiresAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp indicating when the cached report data will expire (estimated).\nCalculated as reportGeneratedAt + cache duration (1 hour for successful reports, 15 minutes for failed reports).\nThis is an estimate with typical accuracy within 1 second of actual Redis TTL expiration.\nOnly present when status is complete or failed.\n"}},"required":["updatedAt","title"]}},"required":["data","columnNames","metadata"]},{"type":"null"}],"description":"Report data (only present when status is complete)"},"failureReason":{"type":["string","null"],"description":"Error information if report generation failed"}},"required":["requestId","status","reportData"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]},"examples":{"initial_request":{"summary":"Report generation in progress","value":{"success":true,"results":{"requestId":"rep_result:12345abc","status":"in_progress","reportData":null,"failureReason":null}}},"complete":{"summary":"Completed report with cache metadata","description":"When includeHeadersInData=false, the data array would be:\n```\nreportData.data: [\n  [ \"Q1 2024\", \"Engineering\", 45 ],\n  [ \"Q1 2024\", \"Sales\", 32 ],\n  [ \"Q2 2024\", \"Engineering\", 52 ]\n]\n```\n","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:00Z","title":"Quarterly Hiring Report","reportGeneratedAt":"2024-01-15T14:25:33.123Z","cacheExpiresAt":"2024-01-15T15:25:33.123Z"}}}}},"failed":{"summary":"Failed report generation (timeout or error)","value":{"success":true,"results":{"requestId":"rep_result:12345abc","status":"failed","reportData":null,"failureReason":"QueryTimeout"}}}}}}},"429":{"description":"Rate limit or concurrent limit exceeded","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"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"}}},"examples":{"rate_limit_exceeded":{"summary":"Rate limit exceeded (15 requests per minute per organization)","value":{"success":false,"errors":["Rate limit exceeded"],"errorInfo":{"code":"rate_limit_exceeded","message":"Your organization has exceeded the rate limit of 15 report requests per minute. Try again in 60 seconds.","requestId":"rep_result:12345abc"}}},"concurrent_limit_exceeded":{"summary":"Concurrent operation limit exceeded (3 maximum per organization)","value":{"success":false,"errors":["Concurrent limit exceeded"],"errorInfo":{"code":"concurrent_limit_exceeded","message":"Your organization has reached the maximum of 3 concurrent report operations. Please wait for existing operations to complete or try again in 30 seconds.","requestId":"rep_result:12345abc"}}}}}}}}}},"/report.synchronous":{"post":{"summary":"report.synchronous","operationId":"reportSynchronous","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`](ref:reportgenerate) instead.\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`](ref:reportgenerate))\n- Rate limits are shared with [`report.generate`](ref:reportgenerate) 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`](ref:reportgenerate) for async processing\n- Concurrent limit is released when the HTTP request completes\n\n**Requires the [`reportsRead`](authentication#permissions-reportsynchronous) permission.**\n","tags":["Report"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reportId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ID of the report"}]},"includeHeadersInData":{"type":"boolean","default":true,"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."}},"required":["reportId"]},"examples":{"standard_request":{"$ref":"#/paths/~1report.generate/post/requestBody/content/application~1json/examples/start_generation"},"no_headers_request":{"summary":"Request without headers in data","value":{"reportId":"f9e52a51-a075-4116-a7b8-484deba69004","includeHeadersInData":false}}}}}},"responses":{"200":{"description":"Responses for the report.synchronous endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","$ref":"#/paths/~1report.generate/post/responses/200/content/application~1json/schema/oneOf/0"},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]},"examples":{"success_response":{"$ref":"#/paths/~1report.generate/post/responses/200/content/application~1json/examples/complete"},"timeout_response":{"$ref":"#/paths/~1report.generate/post/responses/200/content/application~1json/examples/initial_request"}}}}},"429":{"description":"Rate limit or concurrent limit exceeded","content":{"application/json":{"schema":{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"},"examples":{"rate_limit_exceeded":{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/examples/rate_limit_exceeded"},"concurrent_limit_exceeded":{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/examples/concurrent_limit_exceeded"}}}}}}}},"/source.list":{"post":{"summary":"source.list","description":"List all sources\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-sourcelist) permission.**\n","operationId":"sourcelist","tags":["Source"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"includeArchived":{"type":"boolean","description":"When true, includes archived items","default":false}}}}}},"responses":{"200":{"description":"Responses for the source.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","example":"Applied"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"},"sourceType":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string","example":"Inbound"},"isArchived":{"$ref":"#/webhooks/openingCreate/post/requestBody/content/application~1json/schema/properties/data/properties/opening/properties/isArchived"}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]}},"moreDataAvailable":{"type":"boolean","example":false}},"required":["results","moreDataAvailable"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/sourceTrackingLink.list":{"post":{"summary":"sourceTrackingLink.list","description":"List all source custom tracking links\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-sourcetrackinglinklist) permission.**\n","operationId":"sourcetrackinglinklist","tags":["Source Tracking Links"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"includeDisabled":{"type":"boolean","description":"When true, includes disabled tracking links","default":false}}}}}},"responses":{"200":{"description":"Responses for the sourceTrackingLink.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"code":{"type":"string","example":"fx9iL4QtWr"},"enabled":{"type":"boolean","example":true},"sourceId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"link":{"type":"string","example":"https://jobs.ashbyhq.com/example?utm_source=fx9iL4QtWr"}},"required":["id","code","enabled","sourceId","link"]}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/surveyFormDefinition.info":{"post":{"summary":"surveyFormDefinition.info","operationId":"surveyFormDefinitionInfo","description":"Returns details about a single survey form definition by id\n\n**Requires the [`hiringProcessMetadataRead`](authentication#permissions-surveyformdefinitioninfo) permission.**\n","tags":["Survey Form Definition"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"surveyFormDefinitionId":{"allOf":[{"description":"The id of the survey form to fetch"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["surveyFormDefinitionId"]}}}},"responses":{"200":{"description":"Responses for the surveyFormDefinition.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"allOf":[{"$ref":"#/paths/~1referralForm.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/allOf/0"},{"type":"object","properties":{"surveyType":{"$ref":"#/webhooks/surveySubmit/post/requestBody/content/application~1json/schema/properties/data/properties/surveySubmission/properties/surveyType"}}}],"required":["id","title","isArchived","formDefinition","surveyType"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/surveyFormDefinition.list":{"post":{"summary":"surveyFormDefinition.list","operationId":"surveyFormDefinitionList","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.**\n","tags":["Survey Form Definition"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema/properties/cursor"},"syncToken":{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema/properties/syncToken"},"limit":{"$ref":"#/paths/~1brand.list/post/requestBody/content/application~1json/schema/properties/limit"}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}}}}},"responses":{"200":{"description":"Responses for the surveyFormDefinition.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1surveyFormDefinition.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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**Requires the [`candidatesWrite`](authentication#permissions-surveyrequestcreate) permission.**\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","operationId":"surveyRequestCreate","tags":["Survey Request"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["candidateId","applicationId","surveyFormDefinitionId"],"properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate to create a survey request for."}]},"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application to associate with the survey request."}]},"surveyFormDefinitionId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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. \nSurvey forms IDs can be obtained using the `surveyFormDefinition.list` endpoint. \n"}]}}}}}},"responses":{"200":{"description":"Responses for the surveyRequest.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"allOf":[{"description":"The id of the survey request\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"candidateId":{"allOf":[{"description":"The id of the candidate the survey request is for\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"applicationId":{"allOf":[{"description":"The id of the application associated with the survey request\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"surveyFormDefinitionId":{"allOf":[{"description":"The id of the survey form the candidate will fill out when they take the survey\n"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"surveyUrl":{"type":"string","example":"https://you.ashbyhq.com/ashby/survey/3f20b73e-abec-4d62-ba6f-04f2f985f7dd","description":"The URL that the candidate can visit to take the survey.\n"}},"required":["id","candidateId","applicationId","surveyFormDefinitionId","surveyUrl"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"surveyRequestList","tags":["Survey Request"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"surveyType":{"allOf":[{"description":"Returns only the survey requests of the given type. Currently, only `CandidateExperience` is supported."},{"type":"string"},{"enum":["CandidateExperience"]}]},"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"If provided, only returns the offers for the application with the supplied id"}]},"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"If provided, only returns the offers for the candidate with the supplied id"}]}},"required":["surveyType"]}]}}}},"responses":{"200":{"description":"Responses for the surveyRequest.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1surveyRequest.create/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}}}],"required":["results"]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/surveySubmission.create":{"post":{"summary":"surveySubmission.create","description":"Create a new survey submission.\n\n**Requires the [`candidatesWrite`](authentication#permissions-surveySubmissionCreate) permission.**\n","operationId":"surveySubmissionCreate","tags":["Survey Submission"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["candidateId","applicationId","surveyFormDefinitionId","submittedValues"],"properties":{"candidateId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the candidate to create a survey submission for."}]},"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the application to associate with the survey submission."}]},"surveyFormDefinitionId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ID of the survey form definition that submissions are being provided for.\n"}]},"submittedValues":{"type":"object","description":"The values that the candidate submitted in the survey form. \nThe keys of this object should be the IDs from the associated survey's form definition, and the values should be the answers to the questions.\nThe information on what values are expected can be obtained by calling the `surveyFormDefinition.info` endpoint.\n","additionalProperties":true,"example":{"_systemfield_name":"Gob Bluth"}}}}}}},"responses":{"200":{"description":"Responses for the surveySubmission.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/webhooks/surveySubmit/post/requestBody/content/application~1json/schema/properties/data/properties/surveySubmission"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/surveySubmission.list":{"post":{"summary":"surveySubmission.list","operationId":"surveySubmissionList","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.**\n","tags":["Survey Submission"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"type":"object","description":"The type of survey submissions to fetch.\nSupported values: CandidateExperience, Questionnaire.\n","properties":{"surveyType":{"type":"string","description":"The survey types supported by surveySubmission.list.\n","enum":["CandidateExperience","Questionnaire"],"example":"CandidateExperience"}},"required":["surveyType"]},{"$ref":"#/paths/~1opening.list/post/requestBody/content/application~1json/schema"}]}}}},"responses":{"200":{"description":"Responses for the surveySubmission.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"$ref":"#/webhooks/surveySubmit/post/requestBody/content/application~1json/schema/properties/data/properties/surveySubmission"},{"type":"object","properties":{"surveyType":{"$ref":"#/paths/~1surveySubmission.list/post/requestBody/content/application~1json/schema/allOf/0/properties/surveyType"}},"required":["surveyType"]}]}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/user.info":{"post":{"summary":"user.info","description":"Get an Ashby user by id\n\n**Requires the [`organizationRead`](authentication#permissions-userinfo) permission.**\n","operationId":"userInfo","tags":["User"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id to lookup the user"}]}},"required":["userId"]}}}},"responses":{"200":{"description":"Responses for the user.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"$ref":"#/paths/~1candidate.create/post/requestBody/content/application~1json/schema/properties/email/allOf/0"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"managerId":{"description":"The user id of the user's manager","$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"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":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/user.list":{"post":{"summary":"user.list","description":"Get a list of all Ashby users.\n\nSee the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.\n\n**Requires the [`organizationRead`](authentication#permissions-userlist) permission.**\n\nThe `globalRole` property in the response specifies the user's access level in Ashby.\nFor more details on the permissions granted with each role, see our [documentation here](https://docs.ashbyhq.com/user-permissions).\n","operationId":"userList","tags":["User"],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1surveyFormDefinition.list/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"includeDeactivated":{"type":"boolean","default":false,"description":"If set to true, deactivated users are included in the response. \nBy default, deactivated users are not included.\n"}}}]}}}},"responses":{"200":{"description":"Responses for the user.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/user.search":{"post":{"summary":"user.search","description":"Search for an Ashby user by email address\n\n**Requires the [`organizationRead`](authentication#permissions-usersearch) permission.**\n","operationId":"userSearch","tags":["User"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The email to use to search for the user","example":"test@ashbyhq.com"}},"required":["email"]}}}},"responses":{"200":{"description":"Responses for the user.search endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/user.interviewerSettings":{"post":{"summary":"user.interviewerSettings","description":"Get interviewer settings for a user.\n\n**Requires the [`organizationRead`](authentication#permissions-userinfo) permission.**\n","operationId":"userInterviewerSettings","tags":["User"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user to get interviewer settings for"}]}},"required":["userId"]}}}},"responses":{"200":{"description":"Responses for the user.interviewerSettings endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"dailyLimit":{"type":["integer","null"],"description":"Maximum number of interviews per day for this interviewer"},"weeklyLimit":{"type":["integer","null"],"description":"Maximum number of interviews per week for this interviewer"}},"required":["id"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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-userinfo) permission.**\n","operationId":"userUpdateInterviewerSettings","tags":["User"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user to update interviewer settings for"}]},"dailyLimit":{"type":["integer","null"],"description":"Maximum number of interviews per day for this interviewer"},"weeklyLimit":{"type":["integer","null"],"description":"Maximum number of interviews per week for this interviewer"}},"required":["userId"]}}}},"responses":{"200":{"description":"Responses for the user.updateInterviewerSettings endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1user.interviewerSettings/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"userCreateInterviewerPause","tags":["User"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user to pause."}]},"startsAt":{"type":"string","format":"date-time","description":"The start date and time of the pause. Defaults to the current time if not provided.","example":"2024-01-15T00:00:00.000Z"},"endsAt":{"type":"string","format":"date-time","description":"The end date and time of the pause. If not provided, the pause is indefinite.","example":"2024-02-15T00:00:00.000Z"},"comment":{"type":"string","description":"An optional comment describing the reason for the pause.","example":"On vacation"}},"required":["userId"]}}}},"responses":{"200":{"description":"Responses for the user.createInterviewerPause endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","description":"Represents an interviewer pause period during which the user will not be scheduled for interviews.","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The unique id of the interviewer pause."}]},"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user who is paused."}]},"startsAt":{"type":"string","format":"date-time","description":"The start date and time of the pause period.","example":"2024-01-15T00:00:00.000Z"},"endsAt":{"type":["string","null"],"format":"date-time","description":"The end date and time of the pause period. If null, the pause is indefinite.","example":"2024-02-15T00:00:00.000Z"},"comment":{"type":["string","null"],"description":"An optional comment describing the reason for the pause.","example":"On vacation"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the pause was created.","example":"2024-01-14T10:30:00.000Z"}},"required":["id","userId","startsAt","createdAt"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"userListInterviewerPauses","tags":["User"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the user to list pauses for."}]}},"required":["userId"]}}}},"responses":{"200":{"description":"Responses for the user.listInterviewerPauses endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/paths/~1user.createInterviewerPause/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/user.deleteInterviewerPause":{"post":{"summary":"user.deleteInterviewerPause","description":"Deletes an interviewer pause.\n\n**Requires the [`organizationWrite`](authentication#permissions-userdeleteinterviewerpause) permission.**\n","operationId":"userDeleteInterviewerPause","tags":["User"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"interviewerPauseId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interviewer pause to delete."}]}},"required":["interviewerPauseId"]}}}},"responses":{"200":{"description":"Responses for the user.deleteInterviewerPause endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The id of the interviewer pause that was deleted."}]}},"required":["id"]}},"required":["results"]}]},{"title":"Error response","$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/webhook.create":{"post":{"summary":"webhook.create","description":"Creates a webhook setting.\n\n**Requires the [`apiKeysWrite`](authentication#permissions-webhookcreate) scope.**\n","operationId":"webhookcreate","tags":["Webhook"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"webhookType":{"type":"string","enum":["applicationSubmit","applicationUpdate","candidateHire","candidateStageChange","candidateDelete","candidateMerge","interviewPlanTransition","interviewScheduleCreate","interviewScheduleUpdate","jobPostingUpdate","jobPostingPublish","jobPostingUnpublish","offerCreate","offerUpdate","offerDelete","pushToHRIS","surveySubmit"]},"requestUrl":{"type":"string","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.\n"}},"required":["webhookType","requestUrl","secretToken"]}}}},"responses":{"200":{"description":"Responses from the webhook.create endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"enabled":{"type":"boolean","description":"Whether or not the webhook setting is enabled."},"requestUrl":{"type":"string","description":"The URL the webhook will send requests to.","example":"https://example.com/webhook"},"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.\n","example":"0c2f9463f87641919f8106a2c49d7a57"},"webhookType":{"type":"string","description":"The type of webhook.","$ref":"#/paths/~1webhook.create/post/requestBody/content/application~1json/schema/properties/webhookType"}},"required":["id","enabled","requestUrl","secretToken","webhookType"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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.**\n","operationId":"webhookInfo","tags":["Webhook"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"webhookId":{"allOf":[{"description":"The id of the webhook setting to retrieve."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["webhookId"]}}}},"responses":{"200":{"description":"Responses from the webhook.info endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"enabled":{"type":"boolean","description":"Whether or not the webhook setting is enabled."},"requestUrl":{"type":"string","description":"The URL the webhook will send requests to.","example":"https://example.com/webhook"},"webhookType":{"type":"string","description":"The type of webhook.","$ref":"#/paths/~1webhook.create/post/requestBody/content/application~1json/schema/properties/webhookType"}},"required":["id","enabled","requestUrl","webhookType"]}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/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-webhookcreate) permission.**\n","operationId":"webhookupdate","tags":["Webhook"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"webhookId":{"allOf":[{"description":"The id of the webhook setting to update."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"enabled":{"type":"boolean","description":"Whether or not the webhook is enabled."},"requestUrl":{"type":"string","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.\n"}},"required":["webhookId"]}}}},"responses":{"200":{"description":"Responses from the webhook.update endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"$ref":"#/paths/~1webhook.create/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}},"/webhook.delete":{"post":{"summary":"webhook.delete","description":"Deletes a webhook setting.\n\n**Requires the [`apiKeysWrite`](authentication#permissions-webhookcreate) permission.**\n","operationId":"webhookdelete","tags":["Webhook"],"requestBody":{"content":{"application/json":{"schema":{"properties":{"webhookId":{"allOf":[{"description":"The id of the webhook setting to delete."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}},"required":["webhookId"]}}}},"responses":{"200":{"description":"Responses from the webhook.delete endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"$ref":"#/paths/~1job.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/0"},{"type":"object","properties":{"results":{"type":"object","properties":{"webhookId":{"allOf":[{"description":"The id of the webhook setting that was deleted."},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]}}}},"required":["results"]}]},{"$ref":"#/paths/~1report.generate/post/responses/429/content/application~1json/schema"}]}}}}}}}},"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":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}}}}}}}},"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":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}}}}}}}},"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":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"},"offer":{"$ref":"#/webhooks/offerCreate/post/requestBody/content/application~1json/schema/properties/data/properties/offer"}}}}}}}},"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":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application"}}}}}}}},"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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","description":"The unique id of the deleted candidate"}}},"mergedCandidate":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId","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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"fromInterviewPlan":{"description":"The interview plan the job was previously referencing","type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"toInterviewStageId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"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":{"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":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"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":"#/paths/~1interviewEvent.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"}}}}}}}}}}},"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":"#/webhooks/interviewScheduleCreate/post/requestBody/content/application~1json/schema/properties/data/properties/interviewSchedule"},{"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":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"$ref":"#/paths/~1job.setStatus/post/requestBody/content/application~1json/schema/properties/status/allOf/1"},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"jobPostingIds":{"type":"array","items":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"hiringTeam":{"type":"array","items":{"$ref":"#/paths/~1hiringTeam.addMember/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"author":{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"updatedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"openedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"closedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}},"required":["id","title","confidential","status","employmentType","updatedAt"]}}}}}}}},"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":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job"}}}}}}}},"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":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"description":"The job posting's id"}]},"title":{"type":"string","example":"Posting Title","description":"The job posting's title"},"jobId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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":{"type":"object","description":"An object containing the ids of all locations associated with the job posting","properties":{"primaryLocationId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"secondaryLocationIds":{"type":"array","items":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}}},"required":["primaryLocationId","secondaryLocationIds"]},"workplaceType":{"$ref":"#/paths/~1location.create/post/requestBody/content/application~1json/schema/properties/workplaceType/allOf/1"},"employmentType":{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job/properties/employmentType"},"isListed":{"type":"boolean","example":true,"description":"Whether or not the job posting is listed"},"publishedDate":{"type":"string","example":"2021-11-19","description":"The date the job posting was published"},"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":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"}},"required":["id","title","jobId","departmentName","teamName","locationName","locationIds","employmentType","isListed","publishedDate","applyLink","shouldDisplayCompensationOnJobBoard","updatedAt"]}}}}}}}},"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":"#/webhooks/jobPostingUpdate/post/requestBody/content/application~1json/schema/properties/data/properties/jobPosting"}}}}}}}},"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":"#/webhooks/jobPostingUpdate/post/requestBody/content/application~1json/schema/properties/data/properties/jobPosting"}}}}}}}},"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":{"allOf":[{"$ref":"#/paths/~1offer.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"},{"type":"object","properties":{"versions":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"startDate":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/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":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/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":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"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":"#/paths/~1candidate.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/fileHandles/items"}},"author":{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"approvalStatus":{"allOf":[{"type":["string","null"],"enum":["Approved","WaitingOnApprovals","Declined",null]},{"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"]}},"formDefinition":{"$ref":"#/paths/~1offer.start/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/formDefinition"}}}],"required":["formDefinition"]}}}}}}}},"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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"applicationId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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":"#/webhooks/offerCreate/post/requestBody/content/application~1json/schema/properties/data/properties/offer"}}}}}}}},"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":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"openedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"closedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"isArchived":{"type":"boolean","example":false},"archivedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"closeReasonId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"]},"latestVersion":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"identifier":{"type":"string"},"description":{"type":"string"},"authorId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"teamId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"jobIds":{"type":"array","items":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"targetHireDate":{"type":"string"},"targetStartDate":{"type":"string"},"isBackfill":{"type":"boolean"},"employmentType":{"$ref":"#/webhooks/jobCreate/post/requestBody/content/application~1json/schema/properties/data/properties/job/properties/employmentType"},"locationIds":{"type":"array","items":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"hiringTeam":{"type":"array","items":{"$ref":"#/paths/~1hiringTeam.addMember/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"customFields":{"type":"array","description":"An array of custom fields associated with the opening","items":{"$ref":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"]}},"required":["id","isArchived","openingState"]}}}}}}}},"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":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"createdAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"updatedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"$ref":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"name":{"type":"string","example":"James"},"primaryEmailAddress":{"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}},"primaryPhoneNumber":{"allOf":[{"$ref":"#/webhooks/pushToHRIS/post/requestBody/content/application~1json/schema/properties/data/properties/application/properties/candidate/properties/primaryEmailAddress"},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"$ref":"#/paths/~1interviewStage.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"source":{"$ref":"#/paths/~1source.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"},"archiveReason":{"allOf":[{"$ref":"#/paths/~1archiveReason.list/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/items"},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"$ref":"#/paths/~1customField.setValue/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}}},"required":["customFields"]}]},"archivedAt":{"allOf":[{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"departmentId":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}},"required":["id","title"]},"creditedToUser":{"$ref":"#/paths/~1user.info/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"},"hiringTeam":{"type":"array","items":{"$ref":"#/paths/~1hiringTeam.addMember/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results"}},"appliedViaJobPostingId":{"allOf":[{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"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"]}}}}}}}},"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":{"type":"object","properties":{"id":{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},"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":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"},{"type":"null"}]},"submittedAt":{"$ref":"#/paths/~1candidate.createNote/post/requestBody/content/application~1json/schema/properties/createdAt"},"candidateId":{"allOf":[{"description":"The id of the candidate who submitted the survey"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"applicationId":{"allOf":[{"description":"The id of the application that the survey submission is associated with"},{"$ref":"#/paths/~1interviewerPool.addUser/post/requestBody/content/application~1json/schema/properties/userId"}]},"surveyType":{"type":"string","enum":["CandidateDataConsent","CandidateExperience","Diversity","EEOC","Questionnaire"]},"formDefinition":{"$ref":"#/paths/~1offer.start/post/responses/200/content/application~1json/schema/oneOf/0/allOf/1/properties/results/properties/formDefinition"},"submittedValues":{"type":"object","example":{"_systemfield_name":"Gob Bluth"}}},"required":["id","submittedAt","candidateId","surveyType"]}}}}}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"security":[{"WebhookSignature":[]}]}}},"components":{"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"}}},"security":[{"BasicAuth":[]}]}