Created
February 27, 2026 20:04
-
-
Save atomicpages/c605cfde29d31f49f52f9879c7bc1a79 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| {"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"title":{"type":"string","description":"The name of the API key.","example":"Custom Job Board API key"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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","allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}},"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the application to update the source of"}]},"sourceId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"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}},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]},"archiveReason":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["customFields"]}]},"archivedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"departmentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","title"]},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"appliedViaJobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting the candidate applied through"}]},"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"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the application to update the stage of"}]},"interviewStageId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview stage to move the application to."}]},"archiveReasonId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"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}},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]},"archiveReason":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["customFields"]}]},"archivedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"departmentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","title"]},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"appliedViaJobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting the candidate applied through"}]},"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"]}},"required":["results"]}]},{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the candidate to consider for a job"}]},"jobId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job to consider the candidate for"}]},"interviewPlanId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The source to set on the application being created."}]},"creditedToUserId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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"},{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}]},"applicationHistory":{"allOf":[{"type":"array","description":"An array of objects representing the application history.","items":{"type":"object","properties":{"stageId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"},{"description":"An ISO date string representing the time the application entered this stage."}]},"archiveReasonId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"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}},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]},"archiveReason":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["customFields"]}]},"archivedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"departmentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","title"]},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"appliedViaJobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting the candidate applied through"}]},"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"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"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}},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]},"archiveReason":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["customFields"]}]},"archivedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"departmentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","title"]},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"appliedViaJobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting the candidate applied through"}]},"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"]},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"isArchived":{"type":"boolean","example":false},"archivedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closeReasonId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"]},"latestVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"identifier":{"type":"string"},"description":{"type":"string"},"authorId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"teamId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"targetHireDate":{"type":"string"},"targetStartDate":{"type":"string"},"isBackfill":{"type":"boolean"},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"customFields":{"type":"array","description":"An array of custom fields associated with the opening","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"]}},"required":["id","isArchived","openingState"]}}}},{"type":"object","properties":{"applicationHistory":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"stageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","title":"Title","example":"Offer"},"enteredStageAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"leftStageAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Actor ID","description":"The ID of the user that performed the stage change."}},"required":["id","stageId","title","enteredStageAt","allowedActions","stageNumber"]}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}}}}}}}}}}}},"submittedValues":{"type":"object","example":{"_systemfield_name":"Gob Bluth"}}},"required":["id","formDefinition","submittedValues"]}},"referrals":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"referredAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}}}},"resumeFileHandle":{"description":"The id, name and handle for the application's resume","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"}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"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":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"createdAfter":1659979196538,"cursor":"qA","syncToken":"6W05prn4d","limit":25}},{"properties":{"status":{"type":"string","enum":["Hired","Archived","Active","Lead"]},"jobId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"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}},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]},"archiveReason":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["customFields"]}]},"archivedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"departmentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","title"]},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"appliedViaJobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting the candidate applied through"}]},"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"]},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"isArchived":{"type":"boolean","example":false},"archivedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closeReasonId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"]},"latestVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"identifier":{"type":"string"},"description":{"type":"string"},"authorId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"teamId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"targetHireDate":{"type":"string"},"targetStartDate":{"type":"string"},"isBackfill":{"type":"boolean"},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"customFields":{"type":"array","description":"An array of custom fields associated with the opening","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"]}},"required":["id","isArchived","openingState"]}}}}]}}}}],"required":["results"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the application to transfer."}]},"jobId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job to transfer the application to."}]},"interviewPlanId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the interview plan to transfer the application to. \n"}]},"interviewStageId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"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}},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]},"archiveReason":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["customFields"]}]},"archivedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"departmentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","title"]},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"appliedViaJobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting the candidate applied through"}]},"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"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the application to update"}]},"sourceId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The source to set on the application being created."}]},"creditedToUserId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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"},{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}]},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"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}},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]},"archiveReason":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["customFields"]}]},"archivedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"departmentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","title"]},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"appliedViaJobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting the candidate applied through"}]},"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"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"stageNumber":{"type":"integer","title":"Stage Number","description":"The order of the history event in the application's history. 0 is the first event."},"enteredStageAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time","description":"The time the application entered the stage."},"applicationHistoryId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Application History ID","description":"The id of the application history event to update if you are updating an existing event."},"archiveReasonId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"status":{"type":"string","enum":["Hired","Archived","Active","Lead"],"description":"The status of the application"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"candidate":{"type":"object","description":"The candidate associated with the application","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"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}},{"example":{"value":"222-222-3344","type":"Work","isPrimary":true}}]}},"required":["id","name"]},"currentInterviewStage":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"]},"archiveReason":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]},{"type":"object","properties":{"customFields":{"type":"array","description":"Archive detail custom field values","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["customFields"]}]},"archivedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"departmentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["id","title"]},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"appliedViaJobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting the candidate applied through"}]},"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"]},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"isArchived":{"type":"boolean","example":false},"archivedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closeReasonId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"]},"latestVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"identifier":{"type":"string"},"description":{"type":"string"},"authorId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"teamId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"targetHireDate":{"type":"string"},"targetStartDate":{"type":"string"},"isBackfill":{"type":"boolean"},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"customFields":{"type":"array","description":"An array of custom fields associated with the opening","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"]}},"required":["id","isArchived","openingState"]}}}},{"type":"object","properties":{"applicationHistory":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"stageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","title":"Title","example":"Offer"},"enteredStageAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"leftStageAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Actor ID","description":"The ID of the user that performed the stage change."}},"required":["id","stageId","title","enteredStageAt","allowedActions","stageNumber"]}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}}}}}}}}}}}},"submittedValues":{"type":"object","example":{"_systemfield_name":"Gob Bluth"}}},"required":["id","formDefinition","submittedValues"]}},"referrals":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"referredAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}}}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}},{"required":["applicationId"],"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 application.listHistory endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"stageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","title":"Title","example":"Offer"},"enteredStageAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"leftStageAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","title":"Actor ID","description":"The ID of the user that performed the stage change."}},"required":["id","stageId","title","enteredStageAt","allowedActions","stageNumber"]}}}}],"required":["results"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}},{"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}}],"required":["applicationId"]}}}},"responses":{"200":{"description":"Responses for the application.listCriteriaEvaluations endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"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":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"createdAfter":1659979196538,"cursor":"qA","syncToken":"6W05prn4d","limit":25}},{"type":"object","properties":{"applicationId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}}}}}}}}}}}},"submittedValues":{"type":"object","example":{"_systemfield_name":"Gob Bluth"}}},"required":["id","formDefinition","submittedValues"]},{"type":"object","properties":{"submittedByUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"interviewId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewEventId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"feedbackFormDefinitionId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationHistoryId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"applicationId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"submittedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}}}],"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to assign the role to."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to assign."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}}}}},"responses":{"200":{"description":"Responses for the application.addHiringTeamMember 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":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to unassign the role from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to unassign."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}}}}},"responses":{"200":{"description":"Responses for the application.removeHiringTeamMember 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":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"}},"required":["id","title"]}]}}}}],"required":["results"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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- `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\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":{"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"]},"formDefinitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the feedback form definition associated with the form submission"}]},"applicationId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the application you're submitting feedback for"}]},"userId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"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"]},"formDefinitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the feedback form definition associated with the form submission"}]},"applicationId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the application you're submitting feedback for"}]},"userId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"submittedFormInstance":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}}}}}}}}}}}},"submittedValues":{"type":"object","example":{"_systemfield_name":"Gob Bluth"}}},"required":["id","formDefinition","submittedValues"]}}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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`.\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","operationId":"applicationformsubmit","tags":["Application Form"],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["jobPostingId","applicationForm"],"properties":{"jobPostingId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting to submit an application for"}]},"applicationForm":{"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"]},"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"submittedFormInstance":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}}}}}}}}}}}},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}},{"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"approvalDefinitionId":{"allOf":[{"description":"The id of the approval definition associated to this approval."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"entityId":{"allOf":[{"description":"The id of the approval entity (e.g. the id of the offer version)."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"entityType":{"type":"string","enum":["offer","job","opening"]},"createdAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}]},"submittedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"description":"The date when the approval was submitted and sent to users for approval."}]},"completedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"description":"The date when the approval was completed and approved by everyone."}]},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"approvalsRequired":{"type":"integer","description":"The number of approvers required to approve this step, before the approval moves on to the next step."},"completedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"userId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of a user who is an approver for this step."}]},"decision":{"type":"string","enum":["approve","reject","pending"]},"decidedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"description":"The date when the decision was taken by the user."}]},"requestedAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},{"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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)."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"allOf":[{"description":"The id of the approval definition."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"entityType":{"type":"string","enum":["Offer"]},"entityId":{"allOf":[{"description":"The id of the approval entity (e.g. the id of the offer version)."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of a user who is an approver for this step."}]},"type":{"type":"string","enum":["user"]}},"required":["userId","type"]}}},"required":["approvalsRequired","approvers"]}}},"required":["entityType","entityId","approvalStepDefinitions"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"text":{"type":"string","example":"Too inexperienced"},"reasonType":{"enum":["RejectedByCandidate","RejectedByOrg","Other"],"example":"RejectedByOrg"},"isArchived":{"type":"boolean","example":false}},"required":["id","text","reasonType","isArchived"]}}}},{"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the candidate, to whom to add the completed assessment"}]},"partnerId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"assessmentId":{"allOf":[{"description":"An identifier that uniquely identifies the completed assessment"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"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"]}]},"metadata":{"type":"array","description":"An array of metadata associated with this completed assessment","items":{"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"]}}}},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"properties":{"results":{"type":"object","required":["assessmentTypeId","assessmentId","assessmentName","candidateId","metadata"],"properties":{"applicationId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"assessmentId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"assessmentName":{"type":"string","example":"test-assessment-name"},"assessmentTypeId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"candidateId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"metadata":{"type":"array","items":{"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"]}},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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)"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"string","enum":["Hired","Archived","Active","Lead"]},{"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":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}}}}]}}}}}},"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":{"type":"object","required":["assessment_id","timestamp"],"properties":{"assessment_id":{"allOf":[{"description":"Identifier of the assessment being updated"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"timestamp":{"type":"integer","description":"The timestamp in milliseconds since the unix epoch, when the update occurred","format":"int64","example":1665680638489},"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."},{"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"]}]},"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."},{"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"]}]},"assessment_result":{"allOf":[{"description":"The result of the assessment. Sending an update with this field will signal to Ashby that the assessment is complete."},{"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"]}]},"cancelled_reason":{"allOf":[{"description":"The reason the assessment was cancelled. This field will signal to Ashby that the assessment is cancelled."},{"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"]}]},"metadata":{"type":"array","description":"Any other metadata about the assessment (e.g. ETA until complete). All assessment data should have unique identifiers.","items":{"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"]}}}}}}}}}}},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","description":"List of available assessments","properties":{"assessment_type_id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"name":{"type":"string"},"description":{"type":"string"}}}]}}}}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"timestamp":{"type":"integer","description":"The timestamp in milliseconds since the unix epoch, when the update occurred","format":"int64","example":1665680638489},"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."},{"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"]}]},"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."},{"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"]}]},"assessment_result":{"allOf":[{"description":"The result of the assessment. Sending an update with this field will signal to Ashby that the assessment is complete."},{"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"]}]},"cancelled_reason":{"allOf":[{"description":"The reason the assessment was cancelled. This field will signal to Ashby that the assessment is cancelled."},{"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"]}]},"metadata":{"type":"array","description":"Any other metadata about the assessment (e.g. ETA until complete). All assessment data should have unique identifiers.","items":{"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"]}}}}}}},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}}}}},"responses":{"200":{"description":"Responses for the assessment.cancel endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","type":"object","required":["success","results"],"properties":{"success":{"type":"boolean"},"results":{"required":["assessment_id"],"properties":{"assessment_id":{"type":"string"},"update_request":{"type":"object","required":["assessment_id","timestamp"],"properties":{"assessment_id":{"allOf":[{"description":"Identifier of the assessment being updated"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"timestamp":{"type":"integer","description":"The timestamp in milliseconds since the unix epoch, when the update occurred","format":"int64","example":1665680638489},"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."},{"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"]}]},"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."},{"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"]}]},"assessment_result":{"allOf":[{"description":"The result of the assessment. Sending an update with this field will signal to Ashby that the assessment is complete."},{"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"]}]},"cancelled_reason":{"allOf":[{"description":"The reason the assessment was cancelled. This field will signal to Ashby that the assessment is cancelled."},{"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"]}]},"metadata":{"type":"array","description":"Any other metadata about the assessment (e.g. ETA until complete). All assessment data should have unique identifiers.","items":{"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"]}}}}}}}},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error Response","type":"object"}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the candidate"}]},"projectId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","description":"The anonymized candidate","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The source to set on the candidate being created."}]},"creditedToUserId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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"},{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}]}},"required":["name"]}}}},"responses":{"200":{"description":"Responses for the candidate.create 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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"email":{"type":"string","example":"test@ashbyhq.com"}},"required":["id","firstName","lastName"]}},"required":["id","createdAt","isPrivate","author"]}}}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"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":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"createdAfter":1659979196538,"cursor":"qA","syncToken":"6W05prn4d","limit":25}}}}},"responses":{"200":{"description":"Responses for the candidate.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}}}}],"required":["results"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the candidate to fetch client info for"}]}}},{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}}],"required":["candidateId"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004"}}}}},"responses":{"200":{"description":"Responses for the candidate.listClientInfo endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ID of the entity that was related to the client interaction.","example":"57133f77-9362-4397-b395-03bda1f72303"}]},"candidateId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ID of the candidate that interacted with the system.","example":"9d22854f-c929-4b86-9f42-cb71cc0e4fc7"}]},"createdAt":{"allOf":[{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}]}},"required":["id","ipAddress","relatedEntityType","relatedEntityId","candidateId"]}}}}],"required":["results"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the candidate to fetch notes for"}]}}},{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}}],"required":["candidateId"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004"}}}}},"responses":{"200":{"description":"Responses for the candidate.listNotes endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"email":{"type":"string","example":"test@ashbyhq.com"}},"required":["id","firstName","lastName"]}},"required":["id","createdAt","isPrivate","author"]}}}}],"required":["results"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the candidate to fetch projects for"}]}},"required":["candidateId"],"example":{"candidateId":"f9e52a51-a075-4116-a7b8-484deba69004"}},{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}}]}}}},"responses":{"200":{"description":"Responses for the candidate.listProjects endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Office Event"},"description":{"type":"string","example":"Folks invited to office for an event"},"isArchived":{"type":"boolean","example":false},"confidential":{"type":"boolean","example":false},"authorId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"customFieldEntries":{"type":"array","description":"All custom field values associated with the project","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","title"]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","example":"test@ashbyhq.com"},{"description":"Primary, personal email of the candidate to update."}]},"phoneNumber":{"allOf":[{"type":"string","example":"555-555-5555"},{"description":"Primary, personal phone number of the candidate to update."}]},"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."},"websiteUrl":{"type":"string","example":"https://twitter.com/user","description":"Url of the candidate's website. Must be a valid Url."},"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of source for this candidate."}]},"creditedToUserId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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.\n"},{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}]},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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\nThe `Content-Type` of this request must be `multipart/form-data`.\n","tags":["Candidate"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the candidate"}]},"file":{"type":"string","format":"binary","description":"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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\nThe `Content-Type` of this request must be `multipart/form-data`.\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":{"multipart/form-data":{"schema":{"type":"object","properties":{"candidateId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the candidate"}]},"resume":{"type":"string","format":"binary","description":"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The unique id of the candidate"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"name":{"type":"string","example":"Adam Hart","description":"The candidate's name"},"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}},"emailAddresses":{"type":"array","items":{"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":{"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}},"phoneNumbers":{"type":"array","items":{"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}}},"socialLinks":{"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"}}},"tags":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"resumeFileHandle":{"description":"The id, name and handle for the candidate's resume","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"}},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"profileUrl":{"type":"string","description":"The url of the candidate's profile in Ashby"},"source":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Applied"},"isArchived":{"type":"boolean","example":false},"sourceType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Inbound"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["id","title","isArchived"],"description":"The source that created this candidate"},"creditedToUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who receives credit for this candidate"},"timezone":{"description":"The timezone of the candidate","type":"string"},"location":{"description":"The primary location of the candidate","type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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"]}},"required":["id","name","emailAddresses","phoneNumbers","socialLinks","tags","applicationIds","fileHandles","profileUrl"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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"}}},{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}}]}}}},"responses":{"200":{"description":"Responses for the candidateTag.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"type":"object","description":"A tag applied to a candidate","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The tag's unique id"},"title":{"type":"string","example":"Senior Candidate"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]}}}},{"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"type":"object","description":"The reason a job or opening was closed","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The reason's unique id"},"reasonText":{"type":"string","description":"The text of the reason","example":"Position Filled"},"isArchived":{"type":"boolean","example":false}},"required":["id","reasonText","isArchived"]}}}},{"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","description":"A communication template","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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","Date","LongText","MultiValueSelect","Number","NumberRange","String","ValueSelect","Url"]},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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":{"type":"boolean","example":false}}}}},"required":["id","title","objectType","isArchived","fieldType","isRequired"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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":{"type":"boolean","example":false}}}}},"required":["id","title","objectType","isArchived","fieldType","isRequired"]}}},{"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}}]}}}},"responses":{"200":{"description":"Responses for the customField.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success Response","allOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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":{"type":"boolean","example":false}}}}},"required":["id","title","objectType","isArchived","fieldType","isRequired"]}}}},{"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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 - 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","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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":"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":"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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 - 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","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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":"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":"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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":{"type":"boolean","example":false}}}}},"required":["id","title","objectType","isArchived","fieldType","isRequired"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"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 department.create 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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"},"isArchived":{"type":"boolean","example":false},"parentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"},"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"}}},"required":["id","name","isArchived","createdAt","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"},"isArchived":{"type":"boolean","example":false},"parentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"},"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"}}},"required":["id","name","isArchived","createdAt","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"},"isArchived":{"type":"boolean","example":false},"parentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"},"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"}}},"required":["id","name","isArchived","createdAt","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"},"isArchived":{"type":"boolean","example":false},"parentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"},"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"}}},"required":["id","name","isArchived","createdAt","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"type":"boolean","description":"When true, includes archived items","default":false},"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"},"isArchived":{"type":"boolean","example":false},"parentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"},"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"}}},"required":["id","name","isArchived","createdAt","updatedAt"]}}}},{"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"},"isArchived":{"type":"boolean","example":false},"parentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"},"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"}}},"required":["id","name","isArchived","createdAt","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":{"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"},"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 department.update 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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"},"isArchived":{"type":"boolean","example":false},"parentId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"},"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"}}},"required":["id","name","isArchived","createdAt","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"properties":{"results":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"isDefaultForm":{"type":"boolean","description":"Whether this is the default form for the organization"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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","organizationId","title","isArchived","isDefaultForm","formDefinition"]},{"type":"object","properties":{"organizationId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"isDefaultForm":{"type":"boolean","example":true},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the interview associated with the feedback form."}]}}}]}}},{"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"type":"object","properties":{"includeArchived":{"type":"boolean","description":"When true, includes archived items","default":false},"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"includeArchived":false,"cursor":"qA","syncToken":"6W05prn4d","limit":25}}}}},"responses":{"200":{"description":"Responses for the feedbackFormDefinition.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"allOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"isDefaultForm":{"type":"boolean","description":"Whether this is the default form for the organization"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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","organizationId","title","isArchived","isDefaultForm","formDefinition"]},{"type":"object","properties":{"organizationId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"isDefaultForm":{"type":"boolean","example":true},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the interview associated with the feedback form."}]}}}]}}}}],"required":["results"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to assign the role to."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to assign."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}},{"type":"object","title":"Job-level","required":["jobId","teamMemberId","roleId"],"properties":{"jobId":{"allOf":[{"description":"The job to assign the user a role on."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to assign the role to."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to assign."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}},{"type":"object","title":"Opening-level","required":["openingId","teamMemberId","roleId"],"properties":{"openingId":{"allOf":[{"description":"The opening to assign the user a role on."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to assign the role to."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to assign."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}}]}}}},"responses":{"200":{"description":"Responses for the hiringTeam.addMember 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":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to unassign the role from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to unassign from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}},{"type":"object","title":"Job-level","required":["jobId","teamMemberId","roleId"],"properties":{"jobId":{"allOf":[{"description":"The job to unassign the user a role from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to unassign the role from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to unassign from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}},{"type":"object","title":"Opening-level","required":["openingId","teamMemberId","roleId"],"properties":{"openingId":{"allOf":[{"description":"The opening to unassign the user a role from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"teamMemberId":{"allOf":[{"description":"The id of the user to unassign the role from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"roleId":{"allOf":[{"description":"The id of the hiring team role to unassign from."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}}}]}}}},"responses":{"200":{"description":"Responses for the hiringTeam.removeMember 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":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"type":"string"},"example":["Recruiter"]}},"required":["results"]}]},{"title":"namesOnly: false","allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"boolean","example":false},{"description":"Whether or not the interview is archived"}]},"isDebrief":{"type":"boolean","example":false,"description":"Whether the interview is a debrief"},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["id","title","isArchived","feedbackFormDefinitionId"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}},{"type":"object","properties":{"includeArchived":{"type":"boolean","description":"When true, includes archived items","default":false},"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"boolean","example":false},{"description":"Whether or not the interview is archived"}]},"isDebrief":{"type":"boolean","example":false,"description":"Whether the interview is a debrief"},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["id","title","isArchived","feedbackFormDefinitionId"]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"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":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"createdAfter":1659979196538,"cursor":"qA","syncToken":"6W05prn4d","limit":25}},{"type":"object","additionalProperties":false,"properties":{"interviewScheduleId":{"allOf":[{"description":"The unique ID of the interview schedule, for which to list interview events"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview event's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"}]},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview's id"},{"example":"ff6c7d9d-71e3-4c9c-88b1-28824980c276"}]},"interviewScheduleId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"null"}],"description":"The interviewer pool this interviewer belongs to, if applicable."}}}],"required":["trainingRole","interviewerPool"]}},"createdAt":{"allOf":[{"description":"The time the interview event was created"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"updatedAt":{"allOf":[{"description":"The time the interview event was last updated"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"startTime":{"allOf":[{"description":"The time the interview event is scheduled to start"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"endTime":{"allOf":[{"description":"The time the interview event is scheduled to end"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"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)"},"hasSubmittedFeedback":{"type":"boolean","description":"Whether or not this interview has any feedback submitted"},"interview":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"boolean","example":false},{"description":"Whether or not the interview is archived"}]},"isDebrief":{"type":"boolean","example":false,"description":"Whether the interview is a debrief"},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["id","title","isArchived","feedbackFormDefinitionId"],"description":"The interview associated with this event (only included if the expand parameter includes \"interview\")"},"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"}}},"required":["id","interviewId","interviewScheduleId","interviewers","createdAt","updatedAt","startTime","endTime","feedbackLink","hasSubmittedFeedback"]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/interviewPlan.list":{"post":{"summary":"interviewPlan.list","operationId":"interviewPlanList","description":"List all interview plans.\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":{"type":"object","properties":{"includeArchived":{"type":"boolean","description":"When true, includes archived items","default":false},"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"includeArchived":false,"cursor":"qA","syncToken":"6W05prn4d","limit":25}}}}},"responses":{"200":{"description":"Responses from the interviewPlan.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Engineering Interview Plan"},"isArchived":{"type":"boolean","example":false}},"required":["id","title","isArchived"]},{"type":"object","properties":{"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2023-09-13T21:30:57.965Z","format":"date-time"}},"required":["createdAt","updatedAt"]}]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"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"],"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who scheduled this interview schedule. Null if the schedule has not been scheduled."},"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":{"type":"object","properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview event's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"}]},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview's id"},{"example":"ff6c7d9d-71e3-4c9c-88b1-28824980c276"}]},"interviewScheduleId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"null"}],"description":"The interviewer pool this interviewer belongs to, if applicable."}}}],"required":["trainingRole","interviewerPool"]}},"createdAt":{"allOf":[{"description":"The time the interview event was created"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"updatedAt":{"allOf":[{"description":"The time the interview event was last updated"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"startTime":{"allOf":[{"description":"The time the interview event is scheduled to start"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"endTime":{"allOf":[{"description":"The time the interview event is scheduled to end"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"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)"},"hasSubmittedFeedback":{"type":"boolean","description":"Whether or not this interview has any feedback submitted"},"interview":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"boolean","example":false},{"description":"Whether or not the interview is archived"}]},"isDebrief":{"type":"boolean","example":false,"description":"Whether the interview is a debrief"},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["id","title","isArchived","feedbackFormDefinitionId"],"description":"The interview associated with this event (only included if the expand parameter includes \"interview\")"},"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"}}},"required":["id","interviewId","interviewScheduleId","interviewers","createdAt","updatedAt","startTime","endTime","feedbackLink","hasSubmittedFeedback"]}}}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"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"}},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"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"],"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who scheduled this interview schedule. Null if the schedule has not been scheduled."},"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":{"type":"object","properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview event's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"}]},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview's id"},{"example":"ff6c7d9d-71e3-4c9c-88b1-28824980c276"}]},"interviewScheduleId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"null"}],"description":"The interviewer pool this interviewer belongs to, if applicable."}}}],"required":["trainingRole","interviewerPool"]}},"createdAt":{"allOf":[{"description":"The time the interview event was created"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"updatedAt":{"allOf":[{"description":"The time the interview event was last updated"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"startTime":{"allOf":[{"description":"The time the interview event is scheduled to start"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"endTime":{"allOf":[{"description":"The time the interview event is scheduled to end"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"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)"},"hasSubmittedFeedback":{"type":"boolean","description":"Whether or not this interview has any feedback submitted"},"interview":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"boolean","example":false},{"description":"Whether or not the interview is archived"}]},"isDebrief":{"type":"boolean","example":false,"description":"Whether the interview is a debrief"},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["id","title","isArchived","feedbackFormDefinitionId"],"description":"The interview associated with this event (only included if the expand parameter includes \"interview\")"},"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"}}},"required":["id","interviewId","interviewScheduleId","interviewers","createdAt","updatedAt","startTime","endTime","feedbackLink","hasSubmittedFeedback"]}}}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"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":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"createdAfter":1659979196538,"cursor":"qA","syncToken":"6W05prn4d","limit":25}},{"type":"object","properties":{"applicationId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the application, for which to fetch interview schedules"}]},"interviewStageId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"properties":{"results":{"type":"array","items":{"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"],"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who scheduled this interview schedule. Null if the schedule has not been scheduled."},"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":{"type":"object","properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview event's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"}]},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview's id"},{"example":"ff6c7d9d-71e3-4c9c-88b1-28824980c276"}]},"interviewScheduleId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"null"}],"description":"The interviewer pool this interviewer belongs to, if applicable."}}}],"required":["trainingRole","interviewerPool"]}},"createdAt":{"allOf":[{"description":"The time the interview event was created"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"updatedAt":{"allOf":[{"description":"The time the interview event was last updated"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"startTime":{"allOf":[{"description":"The time the interview event is scheduled to start"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"endTime":{"allOf":[{"description":"The time the interview event is scheduled to end"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"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)"},"hasSubmittedFeedback":{"type":"boolean","description":"Whether or not this interview has any feedback submitted"},"interview":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"boolean","example":false},{"description":"Whether or not the interview is archived"}]},"isDebrief":{"type":"boolean","example":false,"description":"Whether the interview is a debrief"},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["id","title","isArchived","feedbackFormDefinitionId"],"description":"The interview associated with this event (only included if the expand parameter includes \"interview\")"},"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"}}},"required":["id","interviewId","interviewScheduleId","interviewers","createdAt","updatedAt","startTime","endTime","feedbackLink","hasSubmittedFeedback"]}}}}}}}],"required":["results"]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"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":{"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"}},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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"}]}}},{"type":"array","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":{"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"}},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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"}]}}}}],"properties":{"interviewEventId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of an interview event to update.\n"}]}}},"interviewEventIdToCancel":{"description":"The ids of interview events to cancel.\n","oneOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}]},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"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"],"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"],"description":"The user who scheduled this interview schedule. Null if the schedule has not been scheduled."},"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":{"type":"object","properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview event's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"}]},"interviewId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The interview's id"},{"example":"ff6c7d9d-71e3-4c9c-88b1-28824980c276"}]},"interviewScheduleId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"null"}],"description":"The interviewer pool this interviewer belongs to, if applicable."}}}],"required":["trainingRole","interviewerPool"]}},"createdAt":{"allOf":[{"description":"The time the interview event was created"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"updatedAt":{"allOf":[{"description":"The time the interview event was last updated"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"startTime":{"allOf":[{"description":"The time the interview event is scheduled to start"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"type":"string"},"endTime":{"allOf":[{"description":"The time the interview event is scheduled to end"},{"type":"string","format":"date-time","example":"2022-07-21T17:32:28Z"}],"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)"},"hasSubmittedFeedback":{"type":"boolean","description":"Whether or not this interview has any feedback submitted"},"interview":{"type":"object","properties":{"id":{"allOf":[{"description":"The interview's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"boolean","example":false},{"description":"Whether or not the interview is archived"}]},"isDebrief":{"type":"boolean","example":false,"description":"Whether the interview is a debrief"},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"feedbackFormDefinitionId":{"allOf":[{"description":"The id of the feedback form definition associated with the interview. \n"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["id","title","isArchived","feedbackFormDefinitionId"],"description":"The interview associated with this event (only included if the expand parameter includes \"interview\")"},"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"}}},"required":["id","interviewId","interviewScheduleId","interviewers","createdAt","updatedAt","startTime","endTime","feedbackLink","hasSubmittedFeedback"]}}}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]}},"moreDataAvailable":{"type":"boolean","example":false}},"required":["results","moreDataAvailable"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"interviewPlanId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewPlanId"]}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}},{"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPoolId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"object","properties":{"qualifiedMembers":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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"]}]},{"properties":{"currentProgress":{"type":"object","properties":{"trainingPathId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The id of the training path the user is currently on"},"trainingStageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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","trainingStageId","interviewsCompleted"]}}}],"required":["currentProgress"]}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"object","properties":{"qualifiedMembers":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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"]}]},{"properties":{"currentProgress":{"type":"object","properties":{"trainingPathId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The id of the training path the user is currently on"},"trainingStageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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","trainingStageId","interviewsCompleted"]}}}],"required":["currentProgress"]}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"object","properties":{"qualifiedMembers":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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"]}]},{"properties":{"currentProgress":{"type":"object","properties":{"trainingPathId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The id of the training path the user is currently on"},"trainingStageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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","trainingStageId","interviewsCompleted"]}}}],"required":["currentProgress"]}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPoolId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.archive 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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"object","properties":{"qualifiedMembers":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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"]}]},{"properties":{"currentProgress":{"type":"object","properties":{"trainingPathId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The id of the training path the user is currently on"},"trainingStageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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","trainingStageId","interviewsCompleted"]}}}],"required":["currentProgress"]}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPoolId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.restore 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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"object","properties":{"qualifiedMembers":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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"]}]},{"properties":{"currentProgress":{"type":"object","properties":{"trainingPathId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The id of the training path the user is currently on"},"trainingStageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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","trainingStageId","interviewsCompleted"]}}}],"required":["currentProgress"]}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"interviewerPoolTrainingPathStageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"allOf":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"object","properties":{"qualifiedMembers":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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"]}]},{"properties":{"currentProgress":{"type":"object","properties":{"trainingPathId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The id of the training path the user is currently on"},"trainingStageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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","trainingStageId","interviewsCompleted"]}}}],"required":["currentProgress"]}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["interviewerPoolId","userId"]}}}},"responses":{"200":{"description":"Responses from the interviewerPool.removeUser 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":[{"type":"object","properties":{"id":{"allOf":[{"description":"The pool's id"},{"example":"3ae2b801-19f6-41ef-ad28-214bd731948f"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Backend Technical Screeners","description":"The pool's title"},"isArchived":{"allOf":[{"type":"boolean","example":false},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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},"approvalRequired":{"type":"boolean","description":"Whether or not approval is required for this stage","example":true},"approvers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]}}},"required":["id","interviewerRole","interviewsRequired","approvalRequired"]}}},"required":["id","enabled","trainingStages"]}},"required":["id","title","isArchived"]},{"type":"object","properties":{"qualifiedMembers":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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":[{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},{"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"]}]},{"properties":{"currentProgress":{"type":"object","properties":{"trainingPathId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The id of the training path the user is currently on"},"trainingStageId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","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","trainingStageId","interviewsCompleted"]}}}],"required":["currentProgress"]}}}}]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"defaultInterviewPlanId":{"allOf":[{"description":"The id of the default interview plan for this job. \nA job cannot be opened without a default interview plan.\n"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["title","teamId","locationId"]}}}},"responses":{"200":{"description":"Responses for the job.create 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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"employmentType":{"type":"string"},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"jobPostingIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"author":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","confidential","status","employmentType","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"employmentType":{"type":"string"},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"jobPostingIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"author":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","confidential","status","employmentType","updatedAt"]},{"type":"object","properties":{"location":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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","type":"string","enum":["OnSite","Hybrid","Remote"]},"parentLocationId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"type":{"type":"string","enum":["Location","LocationHierarchy"],"description":"The type of the location component.","example":"Location"},"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"}}},"required":["id","name","isArchived"]},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"isArchived":{"type":"boolean","example":false},"archivedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closeReasonId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"]},"latestVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"identifier":{"type":"string"},"description":{"type":"string"},"authorId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"teamId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"targetHireDate":{"type":"string"},"targetStartDate":{"type":"string"},"isBackfill":{"type":"boolean"},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"customFields":{"type":"array","description":"An array of custom fields associated with the opening","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"]}},"required":["id","isArchived","openingState"]}},"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":{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The component's unique id"}]}},"allOf":[{"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","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"]}]}],"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":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"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":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"createdAfter":1659979196538,"cursor":"qA","syncToken":"6W05prn4d","limit":25}},{"type":"object","properties":{"status":{"type":"array","description":"When supplied, only jobs with the provided status(es) will be returned.","items":{"type":"string","enum":["Draft","Open","Closed","Archived"]}},"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":{"type":"array","description":"Choose to expand the result and include additional data for related objects. \n","items":{"type":"string","enum":["location","openings"]}}}}]}}}},"responses":{"200":{"description":"Responses for the jobPosting.list endpoint","content":{"application/json":{"schema":{"oneOf":[{"title":"Success response","allOf":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"employmentType":{"type":"string"},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"jobPostingIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"author":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","confidential","status","employmentType","updatedAt"]},{"type":"object","properties":{"location":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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","type":"string","enum":["OnSite","Hybrid","Remote"]},"parentLocationId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"type":{"type":"string","enum":["Location","LocationHierarchy"],"description":"The type of the location component.","example":"Location"},"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"}}},"required":["id","name","isArchived"]},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"isArchived":{"type":"boolean","example":false},"archivedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closeReasonId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"openingState":{"type":"string","enum":["Approved","Closed","Draft","Filled","Open"]},"latestVersion":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"identifier":{"type":"string"},"description":{"type":"string"},"authorId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"teamId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"jobIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"targetHireDate":{"type":"string"},"targetStartDate":{"type":"string"},"isBackfill":{"type":"boolean"},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"locationIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"customFields":{"type":"array","description":"An array of custom fields associated with the opening","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","identifier","description","authorId","createdAt","jobIds","isBackfill","employmentType","locationIds","hiringTeam","customFields"]}},"required":["id","isArchived","openingState"]}},"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":{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The component's unique id"}]}},"allOf":[{"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","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"]}]}],"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":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"employmentType":{"type":"string"},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"jobPostingIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"author":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","confidential","status","employmentType","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"Software Engineer","description":"A new title for the job."},"teamId":{"allOf":[{"description":"The new team to associate with the job."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"locationId":{"allOf":[{"description":"The new location to associate with the job."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"defaultInterviewPlanId":{"allOf":[{"description":"The new default interview plan to associate with the job."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"customRequisitionId":{"allOf":[{"description":"The new default custom requisition id for the job."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["jobId"]}}}},"responses":{"200":{"description":"Responses for the job.update 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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"employmentType":{"type":"string"},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"jobPostingIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"author":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","confidential","status","employmentType","updatedAt"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The component's unique id"}]}},"allOf":[{"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","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"]}]}],"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"]},{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"employmentType":{"type":"string"},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"jobPostingIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"author":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","confidential","status","employmentType","updatedAt"]}]}}},{"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"confidential":{"type":"boolean"},"status":{"type":"string","enum":["Draft","Open","Closed","Archived"]},"employmentType":{"type":"string"},"locationId":{"allOf":[{"description":"The id of the location of the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"}]}},"jobPostingIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ids of all job postings associated with the job"}]}},"customRequisitionId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The custom requisition id for a job"}]},"brandId":{"allOf":[{"description":"The id of the brand to use for this job"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"hiringTeam":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"test@ashbyhq.com"},"firstName":{"type":"string","example":"Joey"},"lastName":{"type":"string","example":"Joe"},"role":{"type":"string","example":"Hiring Manager"},"userId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}},"required":["userId","firstName","lastName","email","role"]}},"author":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"firstName":{"type":"string","example":"Test"},"lastName":{"type":"string","example":"User"},"email":{"type":"string","example":"test@ashbyhq.com"},"globalRole":{"type":"string","enum":["Organization Admin","Elevated Access","Limited Access","External Recruiter"]},"isEnabled":{"type":"boolean"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"managerId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e","description":"The user id of the user's manager"},"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":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":["id","firstName","lastName","globalRole","isEnabled","updatedAt"]},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"openedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"closedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","confidential","status","employmentType","updatedAt"]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"isInternal":{"type":"boolean","description":"Whether the job board is an internal board."}},"required":["id","title","isInternal"]}]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]}},"required":["jobId"]}}}},"responses":{"200":{"description":"Responses for the jobInterviewPlan.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":{"type":"object","properties":{"jobId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"stages":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string","example":"Onsite Schedule"},"interviews":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"title":{"type":"string","example":"System Architecture"},"interviewId":{"allOf":[{"description":"The id of the interview to be scheduled"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The id of the job posting to return"}]},"jobBoardId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","properties":{"html":{"type":"string"},"plain":{"type":"string"}},"required":["html","plain"]},{"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":[{"type":"object","properties":{"html":{"type":"string"},"plain":{"type":"string"}},"required":["html","plain"]},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"secondaryLocationIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"required":["primaryLocationId","secondaryLocationIds"]},"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","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"},{"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":{"description":"Whether or not the job posting location is remote","type":"boolean"},"workplaceType":{"allOf":[{"description":"The type of workplace."},{"type":"string","enum":["OnSite","Hybrid","Remote"]}]},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"applicationFormDefinition":{"allOf":[{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}}}}}}}}}}}},{"description":"See the guide on [Creating a Custom Careers Page](https://developers.ashbyhq.com/docs/creating-a-custom-careers-page)"}]},"surveyFormDefinitions":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"isDefaultForm":{"type":"boolean","description":"Whether this is the default form for the organization"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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","organizationId","title","isArchived","isDefaultForm","formDefinition"]},{"type":"object","properties":{"surveyType":{"type":"string","enum":["CandidateDataConsent","CandidateExperience","Diversity","EEOC","Questionnaire"]}}}],"required":["id","title","isArchived","formDefinition","surveyType"]},"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":[{"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","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":{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The component's unique id"}]}},"allOf":[{"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","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"]}]}],"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"}]},"shouldDisplayCompensationOnJobBoard":{"type":"boolean","example":true,"description":"Whether the job posting's settings specify that compensation should be shown to applicants\n"}}},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The job posting's id"}]},"title":{"type":"string","example":"Posting Title","description":"The job posting's title"},"jobId":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"secondaryLocationIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"required":["primaryLocationId","secondaryLocationIds"]},"workplaceType":{"type":"string","enum":["OnSite","Hybrid","Remote"]},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"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":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","jobId","departmentName","teamName","locationName","locationIds","employmentType","isListed","publishedDate","applyLink","shouldDisplayCompensationOnJobBoard","updatedAt"]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"object","properties":{"cursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"},"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":{"type":"number","description":"The maximum number of items to return. The maximum and default value is 100.","example":25}},"example":{"syncToken":"6W05prn4d","cursor":"qA","limit":25}},{"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":[{"allOf":[{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"title":"Success response"},{"type":"object","properties":{"moreDataAvailable":{"type":"boolean","description":"Whether the cursor can be used to fetch a subsequent page of data."},"nextCursor":{"type":"string","description":"Opaque cursor indicating which page of results to fetch","example":"G8"}},"required":["moreDataAvailable"]}]},{"type":"object","properties":{"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"}}}]},{"type":"object","properties":{"results":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"title":{"type":"string"},"status":{"type":"string","enum":["Active","Inactive"]},"locationId":{"allOf":[{"description":"The id of the location of the job template"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"departmentId":{"allOf":[{"description":"The id of the department or team associated with the job template"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"interviewPlanIds":{"type":"array","items":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The ids of all interview plans associated with a job template"}]}},"createdAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"}},"required":["id","title","status"]},{"type":"object","properties":{"location":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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","type":"string","enum":["OnSite","Hybrid","Remote"]},"parentLocationId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"type":{"type":"string","enum":["Location","LocationHierarchy"],"description":"The type of the location component.","example":"Location"},"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"}}},"required":["id","name","isArchived"]},{"description":"The location will only be included if the `location` expand parameter is included when the request is made."}]}}}]}}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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."},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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."},{"type":"string","enum":["OnSite","Hybrid","Remote"]}]},"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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"properties":{"id":{"allOf":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"object","properties":{"html":{"type":"string"},"plain":{"type":"string"}},"required":["html","plain"]},{"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":[{"type":"object","properties":{"html":{"type":"string"},"plain":{"type":"string"}},"required":["html","plain"]},{"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"},{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}]},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"secondaryLocationIds":{"type":"array","items":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"}}},"required":["primaryLocationId","secondaryLocationIds"]},"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","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"},{"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":{"description":"Whether or not the job posting location is remote","type":"boolean"},"workplaceType":{"allOf":[{"description":"The type of workplace."},{"type":"string","enum":["OnSite","Hybrid","Remote"]}]},"employmentType":{"type":"string","enum":["FullTime","PartTime","Intern","Contract","Temporary"]},"applicationFormDefinition":{"allOf":[{"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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"]}}}}}}}}}}}},{"description":"See the guide on [Creating a Custom Careers Page](https://developers.ashbyhq.com/docs/creating-a-custom-careers-page)"}]},"surveyFormDefinitions":{"type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"isDefaultForm":{"type":"boolean","description":"Whether this is the default form for the organization"},"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":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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","organizationId","title","isArchived","isDefaultForm","formDefinition"]},{"type":"object","properties":{"surveyType":{"type":"string","enum":["CandidateDataConsent","CandidateExperience","Diversity","EEOC","Questionnaire"]}}}],"required":["id","title","isArchived","formDefinition","surveyType"]},"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":[{"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","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":{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"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":[{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},{"description":"The component's unique id"}]}},"allOf":[{"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","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"]}]}],"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"}]},"shouldDisplayCompensationOnJobBoard":{"type":"boolean","example":true,"description":"Whether the job posting's settings specify that compensation should be shown to applicants\n"}}},"updatedAt":{"type":"string","example":"2022-08-12T20:29:56.964Z","format":"date-time"},"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"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}}}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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","type":"string","enum":["OnSite","Hybrid","Remote"]},"parentLocationId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"type":{"type":"string","enum":["Location","LocationHierarchy"],"description":"The type of the location component.","example":"Location"},"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"}}},"required":["id","name","isArchived"]}},"required":["results"]}]},{"allOf":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"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"}},"title":"Error response"}]}}}}}}},"/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":[{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","description":"Whether the response is considered successful."}}},{"type":"object","properties":{"results":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"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":{"type":"boolean","example":false},"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","type":"string","enum":["OnSite","Hybrid","Remote"]},"parentLocationId":{"type":"string","format":"uuid","example":"e9ed20fd-d45f-4aad-8a00-a19bfba0083e"},"type":{"type":"string","enum":["Location","LocationHierarchy"],"description":"The type of the location component.","example":"Location"},"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 u |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment