> ## Documentation Index > Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt > Use this file to discover all available pages before exploring further. # Create candidate > Create a new candidate and application for the specified job. This feature is currently available for the following integrations:

You'd like to see this feature for another integration? Please reach out! We're always happy to discuss extending our coverage. **We recommend using the [Create application](/ats/v1/post-jobs-job-id-applications) endpoint instead.** We realized that in practice it was always more about creating _applications_ instead of _candidates_, so we created a new, more aptly named one that you should use instead: [Create application](/ats/v1/post-jobs-job-id-applications) Using it also has the benefit that we return the newly created applicant at the root level, so you can easily store its ID. This endpoint requires the permission **Create applications and candidates** to be enabled in [your scope config](/scopes). ### Example Request Body ```json { "candidate": { "first_name": "Frank", "last_name": "Doe", "company": "Acme Inc.", "title": "Head of Integrations", "email_address": "frank.doe@example.com", "phone_number": "+1-541-754-3010", "gender": "MALE", "salary_expectations": { "amount": 100000, "period": "YEAR" }, "availability_date": "2021-01-01", "location": { "city": "New York", "country": "US", "state": "NY" }, "social_links": [ { "url": "https://www.linkedin.com/in/frank-doe-123456789/" }, { "url": "https://twitter.com/frankdoe" } ] }, "application": { "job_id": "BDpgnpZ148nrGh4mYHNxJBgx", "stage_id": "8x3YKRDcuRnwShdh96ShBNn1" }, "attachments": [ { "name": "Frank Doe CV.txt", "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=", "type": "CV", "content_type": "text/plain" } ], "screening_question_answers": [ { "question_id": "3phFBNXRweGnDmsU9o2vdPuQ", "answer": "Yes" }, { "question_id": "EYJjhMQT3LtVKXnTbnRT8s6U", "answer": [ "GUzE666zfyjeoCJX6A8n7wh6", "5WPHzzKAv8cx97KtHRUV96U8", "7yZfKGzWigXxxRTygqAfHvyE" ] } ], "remote_fields": {} } ``` operationId: PostAtsCandidates parameters: - in: header name: X-Integration-Id schema: type: string description: ID of the integration you want to interact with. example: join:HWUTwvyx2wLoSUHphiWVrp28 required: true requestBody: description: POST /ats/candidates Request body content: application/json: schema: $ref: '#/components/schemas/PostAtsCandidatesRequestBody' examples: example1: value: candidate: first_name: Frank last_name: Doe company: Acme Inc. title: Head of Integrations email_address: frank.doe@example.com phone_number: +1-541-754-3010 gender: MALE salary_expectations: amount: 100000 period: YEAR availability_date: '2021-01-01' location: city: New York country: US state: NY social_links: - url: https://www.linkedin.com/in/frank-doe-123456789/ - url: https://twitter.com/frankdoe application: job_id: BDpgnpZ148nrGh4mYHNxJBgx stage_id: 8x3YKRDcuRnwShdh96ShBNn1 attachments: - name: Frank Doe CV.txt data: >- SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4= type: CV content_type: text/plain screening_question_answers: - question_id: 3phFBNXRweGnDmsU9o2vdPuQ answer: 'Yes' - question_id: EYJjhMQT3LtVKXnTbnRT8s6U answer: - GUzE666zfyjeoCJX6A8n7wh6 - 5WPHzzKAv8cx97KtHRUV96U8 - 7yZfKGzWigXxxRTygqAfHvyE responses: '200': description: POST /ats/candidates Positive response content: application/json: schema: $ref: '#/components/schemas/PostAtsCandidatesPositiveResponse' examples: example1: value: status: success data: id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe company: Acme, Inc. title: Head of Marketing confidential: false source: Employee Referral phone_numbers: - phone_number: +1-541-754-3010 type: HOME email_addresses: - email_address: john.doe@example.com type: PRIVATE social_media: - link: https://www.youtube.com/watch?v=dQw4w9WgXcQ type: YOUTUBE username: null location: city: Berlin country: DE raw: Berlin, Germany state: Berlin street_1: Lohmühlenstraße 65 street_2: null zip_code: '12435' custom_fields: {} integration_fields: [] remote_url: https://app.greenhouse.io/people/32 remote_created_at: '2022-04-02T00:00:00.000Z' remote_updated_at: '2022-04-04T00:00:00.000Z' remote_data: null changed_at: '2022-04-04T00:00:00.000Z' remote_deleted_at: null applications: - id: H77fDF8uvEzGNPRubiz5DvQ7 remote_id: '32' outcome: HIRED rejection_reason_name: null rejected_at: null remote_url: https://app.greenhouse.io/applications/32 changed_at: '2022-04-04T00:00:00.000Z' remote_created_at: '2022-04-02T00:00:00.000Z' remote_updated_at: '2022-04-04T00:00:00.000Z' current_stage: id: 5J7L4b48wBfffYwek9Az9pkM name: Initial Screening remote_id: '32' index: 2 job: id: H5daSm8e85Dmvmne3wLeCPhX name: Backend Engineer remote_id: '32' tags: - id: 26vafvWSRmbhNcxJYqjCzuJg name: High Potential remote_id: '32' warnings: - message: This is an example warning! default: $ref: '#/components/responses/ErrorResponseATS' x-codeSamples: - lang: python label: PostAtsCandidates source: |- from kombo import Kombo from kombo.utils import parse_datetime with Kombo( integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28", api_key="", ) as k_client: res = k_client.ats.create_candidate(candidate={ "first_name": "Frank", "last_name": "Doe", "email_address": "frank.doe@example.com", "company": "Acme Inc.", "title": "Head of Integrations", "phone_number": "+1-541-754-3010", "location": { "city": "New York", "country": "US", "state": "NY", }, "gender": "MALE", "availability_date": parse_datetime("2021-01-01T00:00:00Z"), "salary_expectations": { "period": "YEAR", "amount": 100000, }, "social_links": [ { "url": "https://www.linkedin.com/in/frank-doe-123456789/", }, { "url": "https://twitter.com/frankdoe", }, ], }, application={ "job_id": "BDpgnpZ148nrGh4mYHNxJBgx", "stage_id": "8x3YKRDcuRnwShdh96ShBNn1", }, screening_question_answers=[ { "question_id": "3phFBNXRweGnDmsU9o2vdPuQ", "answer": "Yes", }, { "question_id": "EYJjhMQT3LtVKXnTbnRT8s6U", "answer": [ "GUzE666zfyjeoCJX6A8n7wh6", "5WPHzzKAv8cx97KtHRUV96U8", "7yZfKGzWigXxxRTygqAfHvyE", ], }, ], attachments=[ { "name": "Frank Doe CV.txt", "content_type": "text/plain", "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=", "type": "CV", }, ]) # Handle response print(res) - lang: typescript label: PostAtsCandidates source: |- import { Kombo } from "@kombo-api/sdk"; const kombo = new Kombo({ integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28", api_key: "", }); async function run() { const result = await kombo.ats.createCandidate({ candidate: { first_name: "Frank", last_name: "Doe", email_address: "frank.doe@example.com", company: "Acme Inc.", title: "Head of Integrations", phone_number: "+1-541-754-3010", location: { city: "New York", country: "US", state: "NY", }, gender: "MALE", availability_date: new Date("2021-01-01T00:00:00Z"), salary_expectations: { period: "YEAR", amount: 100000, }, social_links: [ { url: "https://www.linkedin.com/in/frank-doe-123456789/", }, { url: "https://twitter.com/frankdoe", }, ], }, application: { job_id: "BDpgnpZ148nrGh4mYHNxJBgx", stage_id: "8x3YKRDcuRnwShdh96ShBNn1", }, screening_question_answers: [ { question_id: "3phFBNXRweGnDmsU9o2vdPuQ", answer: "Yes", }, { question_id: "EYJjhMQT3LtVKXnTbnRT8s6U", answer: [ "GUzE666zfyjeoCJX6A8n7wh6", "5WPHzzKAv8cx97KtHRUV96U8", "7yZfKGzWigXxxRTygqAfHvyE", ], }, ], attachments: [ { name: "Frank Doe CV.txt", content_type: "text/plain", data: "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=", type: "CV", }, ], }); console.log(result); } run(); - lang: ruby label: PostAtsCandidates source: >- require 'kombo' Models = ::Kombo::Models s = ::Kombo::Kombo.new( integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28', security: Models::Shared::Security.new( api_key: '' ) ) res = s.ats.create_candidate(body: Models::Shared::PostAtsCandidatesRequestBody.new( candidate: Models::Shared::PostAtsCandidatesRequestBodyCandidate.new( first_name: 'Frank', last_name: 'Doe', email_address: 'frank.doe@example.com', company: 'Acme Inc.', title: 'Head of Integrations', phone_number: '+1-541-754-3010', location: Models::Shared::PostAtsCandidatesRequestBodyLocation.new( city: 'New York', country: 'US', state: 'NY' ), gender: Models::Shared::PostAtsCandidatesRequestBodyGender::MALE, availability_date: DateTime.iso8601('2021-01-01T00:00:00Z'), salary_expectations: Models::Shared::PostAtsCandidatesRequestBodySalaryExpectations.new( period: Models::Shared::PostAtsCandidatesRequestBodyPeriod::YEAR, amount: 100_000.0 ), social_links: [ Models::Shared::PostAtsCandidatesRequestBodySocialLink.new( url: 'https://www.linkedin.com/in/frank-doe-123456789/' ), Models::Shared::PostAtsCandidatesRequestBodySocialLink.new( url: 'https://twitter.com/frankdoe' ), ] ), application: Models::Shared::PostAtsCandidatesRequestBodyApplication.new( job_id: 'BDpgnpZ148nrGh4mYHNxJBgx', stage_id: '8x3YKRDcuRnwShdh96ShBNn1' ), screening_question_answers: [ Models::Shared::PostAtsCandidatesRequestBodyScreeningQuestionAnswer.new( question_id: '3phFBNXRweGnDmsU9o2vdPuQ', answer: 'Yes' ), Models::Shared::PostAtsCandidatesRequestBodyScreeningQuestionAnswer.new( question_id: 'EYJjhMQT3LtVKXnTbnRT8s6U', answer: [ 'GUzE666zfyjeoCJX6A8n7wh6', '5WPHzzKAv8cx97KtHRUV96U8', '7yZfKGzWigXxxRTygqAfHvyE', ] ), ], attachments: [ Models::Shared::PostAtsCandidatesRequestBodyAttachment.new( name: 'Frank Doe CV.txt', content_type: 'text/plain', data: 'SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=', type: Models::Shared::PostAtsCandidatesRequestBodyAttachmentType::CV ), ] )) unless res.post_ats_candidates_positive_response.nil? # handle response end components: schemas: PostAtsCandidatesRequestBody: type: object properties: candidate: type: object properties: first_name: type: string description: The first name of the candidate. last_name: type: string description: The last name of the candidate. email_address: type: string description: The primary email address this application will be created with. format: email additional_email_addresses: type: array items: type: object properties: type: type: string enum: - PERSONAL - WORK - OTHER email_address: type: string format: email required: - type - email_address company: type: string description: The company where the candidate is currently working. title: type: string description: The current job title of the candidate. phone_number: type: string description: The phone number of the candidate. additional_phone_numbers: type: array items: type: object properties: type: type: string enum: - PERSONAL - WORK - OTHER phone_number: type: string required: - type - phone_number location: type: object properties: city: type: string country: type: string pattern: ^[A-Z]{2}$ description: >- The uppercase two-letter ISO country (e.g., `DE`). For systems that use codes in formats other than `ISO 3166-1 alpha-2`, Kombo transforms the ISO Codes to the appropriate value. state: type: string street_1: type: string zip_code: type: string required: - country description: The location of the candidate. gender: type: string enum: - MALE - FEMALE - OTHER description: >- The gender of the candidate. Must be one of `MALE`, `FEMALE`, or `OTHER`. availability_date: description: The date the candidate is available to start working. type: string format: date-time pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString salary_expectations: type: object properties: period: type: string enum: - MONTH - YEAR description: >- The period of the salary expectations. Must be one of `MONTH` or `YEAR`. amount: type: number format: double minimum: -1.7976931348623157e+308 description: The amount of the salary expectations. required: - period - amount description: >- The salary expectations of the applicant. We will automatically convert the amount to a format that is suitable for the ATS you are using. For example, if you are using monthly salary expectations, we will convert the amount to a yearly salary if the ATS expects yearly salary expectations. social_links: type: array items: type: object properties: url: type: string format: uri required: - url default: [] description: >- A list of social media links of the candidate. The links must be valid URLs. required: - first_name - last_name - email_address application: type: object properties: job_id: type: string description: >- The Kombo ID or Remote ID of the Job this candidate should apply to. If you want to use the ID of the integrated system (remote_id) you need to prefix the ID with "remote:". You can use the remote ID if you do not want to sync jobs. stage_id: type: string description: >- Stage this candidate should be in. If left out, the default stage for this job will be used. required: - job_id description: >- Currently, every candidate has one application. If you are interested in talent pools, please contact Kombo. screening_question_answers: type: array items: type: object properties: question_id: type: string description: >- ID of the question returned by the Kombo API. We'll report a warning in the logs if the question can't be found on the job. answer: anyOf: - type: string description: >- Answer to a `TEXT` question or the option ID of the answer to a `SINGLE_SELECT` question. - type: boolean description: Answer to a `BOOLEAN` question. - type: number format: double minimum: -1.7976931348623157e+308 description: Answer to a `NUMBER` question. - type: array items: type: string description: >- Answer to a `MULTI_SELECT` question. The array elements are the IDs of the selected options. - description: Answer to a `DATE` question as an ISO 8601 date string. type: string format: date-time pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString - type: object properties: name: type: string description: >- File name of the file you want to upload. We recommend providing something human-readable with a valid file extension (like `Resume.pdf`), as this might be shown in your customer's system. content_type: type: string pattern: ^[\w.-]+\/[\w.-]+$ description: >- Content/MIME type of the file (e.g., `application/pdf`). If you provide `data`, this is required. If you provide `data_url`, this is optional and we'll attempt to use the `Content-Type` header of the response. **Note:** Please validate that the content type you provide is actually meaningful (and not something generic like [`application/octet-stream`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/MIME_types#applicationoctet-stream)). Especially when using object storage (like AWS S3), it's easy to accidentally discard the content types of user-provided files, so make sure to explicitly persist them when processing uploads from your users (see guides for [AWS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#SysMetadata), [Google Cloud](https://cloud.google.com/storage/docs/metadata#content-type), and [Azure](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types)). data_url: type: string format: uri description: >- URL to the file you want to upload that can be accessed without authentication headers. We will download the content immediately when receiving the request, so the URL can be short-lived. If you're using an object storage provider (like AWS S3), we strongly recommend providing a signed URL for secure access (see guides for [AWS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html), [Google Cloud](https://cloud.google.com/storage/docs/access-control/signed-urls), and [Azure](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview)). **Note:** You must provide either this or `data_url`. We recommend `data_url` over `data` for most cases. data: type: string description: >- Base64-encoded contents of the file you want to upload. **Note:** You must provide either this or `data_url`. We recommend `data_url` over `data` for most cases. required: - name description: Answer to a `FILE` question. description: >- Answer to a question. This will be validated based on the question format and throw an error if the answer is invalid. Here is a description of each question type and the required answer format: `TEXT` - Simply provide a "string" answer. `SINGLE_SELECT` - Provide the ID of the answer as a string. `MULTI_SELECT` - Provide a string array containing the question IDs of the selected options. `BOOLEAN` - Either `true` or `false`. `NUMBER` - A number. `DATE` - Provide the answer as an ISO 8601 date string. `FILE` - Please select Option 6 in the dropdown above to see the required format. required: - question_id - answer description: >- Array of answers to screening questions. Currently, not all question types are supported, and unsupported ones will not be submitted. The available questions for a job can be retrieved from the get jobs endpoint. The answers will be validated based on the format of the questions. Make sure to follow this schema to avoid errors. examples: - - question_id: D8yPrjXXvA2XeBksTmrVvKSn answer: 'Yes' attachments: type: array items: type: object properties: name: type: string description: >- File name of the file you want to upload. We recommend providing something human-readable with a valid file extension (like `Resume.pdf`), as this might be shown in your customer's system. content_type: type: string pattern: ^[\w.-]+\/[\w.-]+$ description: >- Content/MIME type of the file (e.g., `application/pdf`). If you provide `data`, this is required. If you provide `data_url`, this is optional and we'll attempt to use the `Content-Type` header of the response. **Note:** Please validate that the content type you provide is actually meaningful (and not something generic like [`application/octet-stream`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/MIME_types#applicationoctet-stream)). Especially when using object storage (like AWS S3), it's easy to accidentally discard the content types of user-provided files, so make sure to explicitly persist them when processing uploads from your users (see guides for [AWS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#SysMetadata), [Google Cloud](https://cloud.google.com/storage/docs/metadata#content-type), and [Azure](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types)). data_url: type: string format: uri description: >- URL to the file you want to upload that can be accessed without authentication headers. We will download the content immediately when receiving the request, so the URL can be short-lived. If you're using an object storage provider (like AWS S3), we strongly recommend providing a signed URL for secure access (see guides for [AWS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html), [Google Cloud](https://cloud.google.com/storage/docs/access-control/signed-urls), and [Azure](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview)). **Note:** You must provide either this or `data_url`. We recommend `data_url` over `data` for most cases. data: type: string description: >- Base64-encoded contents of the file you want to upload. **Note:** You must provide either this or `data_url`. We recommend `data_url` over `data` for most cases. type: type: string enum: - CV - COVER_LETTER - OTHER description: >- Type of the attachment in the ATS. This may affect where the uploaded file will be shown in your customer's system. required: - name - type default: [] description: An array of the attachments you would like upload. source: type: object properties: name: type: string description: Name of the source (e.g., `"Example Job Board"`). unified_key: type: string id: type: string description: >- **(⚠️ Deprecated - Use [automatic source writing](/ats/features/application-attribution#automatic-attribution) instead)** Optional source information that will be attached to the candidate. If you're a job board or recruiting service, you can use this to make sure your customers can see which candidates came from you. This is deprecated because writing sources requires users to do some setup in most ATSs. deprecated: true sourced_by: type: object properties: user_id: type: string description: >- The Kombo ID or Remote ID of the User. Use the Kombo ID directly, or prefix the remote ID with "remote:" to reference the user by their ID in the remote system. required: - user_id description: >- Credit the recruiter or team member who sourced this candidate. While the `source` field tracks the channel/platform (e.g., "Awesome Jobboard"), the `sourced_by` field tracks the individual person responsible for finding the candidate. gdpr_consent: type: object properties: expires_at: description: >- Until when the candidate has granted the company they're applying to permission to process their personal data. type: string format: date-time pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString given: type: boolean description: Whether the candidate has given consent. description: >- Optional GDPR consent information required in some jurisdictions (like the Czech Republic or Slovakia). remote_fields: allOf: - type: object properties: successfactors: type: object properties: Candidate: type: object additionalProperties: true description: >- Fields that we will pass through to SuccessFactor's `Candidate` object. JobApplication: type: object additionalProperties: true description: >- Fields that we will pass through to SuccessFactor's `JobApplication` object. copyJobApplicationAttachments: type: boolean description: >- If set to true, we will copy custom attachments from the JobApplication to the Candidate. update_existing_candidate: type: - boolean - 'null' description: >- When the candidate already exists, whether to update the Candidate with the remote fields found under the Candidate entity. description: Fields specific to SAP SuccessFactors. personio: type: object properties: application: type: object additionalProperties: true description: >- Fields that we will pass through to Personio's `application` object. description: Fields specific to Personio. talentsoft: type: object properties: applicant: type: object additionalProperties: true description: >- Fields that we will pass through to TalentSoft's `applicant` object. application: type: object additionalProperties: true description: >- Fields that we will pass through to TalentSoft's `application` object. description: Fields specific to TalentSoft. teamtailor: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to Teamtailor's `Candidate` object. application: type: object properties: attributes: type: object additionalProperties: true description: >- Fields that we will pass through to Teamtailor's attributes section `Job application` object. greenhouse: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to Greenhouse's `Candidate` object. application: type: object additionalProperties: true description: >- Fields that we will pass through to Greenhouse's `Application` object. description: Fields specific to Greenhouse. greenhousev3: type: object properties: candidate: type: object additionalProperties: true description: >- Additional fields passed through to Greenhouse V3's `POST /v3/candidates` request body. application: type: object additionalProperties: true description: >- Additional fields passed through to Greenhouse V3's `POST /v3/applications` request body. description: Fields specific to Greenhouse V3 (OAuth-based connector). lever: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to Lever's `Candidate` object. Note: make sure to submit the keys and values in the correct form data format. description: Fields specific to Lever. workable: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to Workable's `Candidate` object. description: Fields specific to Workable. workday: type: object properties: Candidate_Data: type: object properties: Name_Detail_Data: type: object properties: Middle_Name: type: string description: The candidate's middle name Social_Suffix_Reference: type: object properties: Predefined_Name_Component_ID: type: string required: - Predefined_Name_Component_ID description: >- The WID of the social suffix reference for the candidate Language_Reference: type: object properties: WID: type: string required: - WID description: Used to set the candidate's primary language Job_Application_Data: type: object properties: Job_Applied_To_Data: type: object properties: Global_Personal_Information_Data: type: object properties: Date_of_Birth: type: string Resume_Data: type: object properties: Education_Data: type: array items: type: object properties: School_Name: type: string First_Year_Attended: type: number format: double minimum: -1.7976931348623157e+308 Last_Year_Attended: type: number format: double minimum: -1.7976931348623157e+308 Field_of_Study_Reference: type: object properties: WID: type: string required: - WID Degree_Reference: type: object properties: WID: type: string required: - WID Grade_Average: type: string Skill_Data: type: array items: type: object properties: Skill_Name: type: string Language_Data: type: array items: type: object properties: Language_Reference: type: object properties: WID: type: string Language: type: object properties: Native: type: boolean Language_Ability: type: array items: type: object properties: Language_Ability_Data: type: object properties: Language_Proficiency_Reference: type: object properties: WID: type: string required: - WID Language_Ability_Type_Reference: type: object properties: WID: type: string required: - WID required: - Language_Ability Experience_Data: type: array items: type: object properties: Company_Name: type: string Title: type: string Location: type: string Start_Date: description: YYYY-MM-DDTHH:mm:ss.sssZ type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString End_Date: description: YYYY-MM-DDTHH:mm:ss.sssZ type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString Currently_Work_Here: type: boolean Description: type: string required: - Company_Name - Title - Start_Date Contact_Data: type: object properties: Location_Data: type: object properties: Address_Line_1: type: string Address_Line_2: type: string Region_Subdivision_1: type: string Country_Region_Reference: type: object properties: Country_Region_ID: type: string required: - Country_Region_ID Country_City_Reference: type: object properties: WID: type: string required: - WID Worker_Reference: type: object properties: WID: type: string Employee_ID: type: string description: >- Reference to the Worker (employee) to link the candidate to. Provide either WID or Employee_ID. Override_Source_Reference_WID: type: string description: Used to override the automatic source WID. description: >- Fields specific to Workday. The remote fields schema follows the documentation at https://community.workday.com/sites/default/files/file-hosting/productionapi/Recruiting/v43.0/Put_Candidate.html. Only defined fields are supported, if you need additional field support please reach out to Kombo support. zohorecruit: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to Zoho Recruit's `Candidate` object. description: Fields specific to Zoho Recruit. bullhorn: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to Bullhorn's `Candidate` object. job_submission: type: object additionalProperties: true description: >- Fields that we will pass through to Bullhorn's `JobSubmission` object. description: Fields specific to Bullhorn. smartrecruiters: type: object properties: candidate_with_questions: type: object additionalProperties: true description: >- **(⚠️ Deprecated - Use the `candidate` field instead.)** Fields that we will pass through to the SmartRecruiters's `Candidate` object when created with screening question answers. This API is used: https://developers.smartrecruiters.com/reference/createcandidate-1 deprecated: true candidate_without_questions: type: object additionalProperties: true description: >- **(⚠️ Deprecated - Use the `candidate` field instead.)** Fields that we will pass through to the SmartRecruiters's `Candidate` object when created with screening question answers. This API is used: https://developers.smartrecruiters.com/reference/candidatesaddtojob-1 deprecated: true candidate: type: object additionalProperties: true description: >- Fields that we will pass through to the SmartRecruiters's `Candidate` object. This API is used: https://developers.smartrecruiters.com/reference/createcandidate-1 consent_decisions: type: object properties: SINGLE: type: boolean SMART_RECRUIT: type: boolean SMART_CRM: type: boolean SMART_MESSAGE_SMS: type: boolean SMART_MESSAGE_WHATSAPP: type: boolean description: >- The consent decisions for the candidate. SmartRecruiters supports two consent models: 'Single' (use the `SINGLE` key) and 'Separated' (use `SMART_RECRUIT`, `SMART_CRM`, `SMART_MESSAGE_SMS`, and/or `SMART_MESSAGE_WHATSAPP` keys). When this field is provided, it takes precedence over the `gdpr_consent` field for the `consentDecisions` property. See: https://developers.smartrecruiters.com/docs/partners-post-an-application description: Fields specific to SmartRecruiters. talentadore: type: object properties: applications: type: object additionalProperties: true description: >- Fields that we will pass through to the Talentadore's when creating applications. description: Fields specific to Talentadore. guidecom: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to GuideCom's `Candidate` object. description: Fields specific to GuideCom. dvinci: type: object properties: application: type: object additionalProperties: true description: >- Fields that we will pass through to d.vinci's application object. This API is used: https://static.dvinci-easy.com/files/d.vinci%20application-apply-api.html#jobs__id__applyApi_post candidate: type: object additionalProperties: true description: >- Fields that we will pass through to d.vinci's candidate/application payload as top-level fields (e.g., dateOfBirth). description: Fields specific to d.vinci. hrworks: type: object properties: jobApplication: type: object additionalProperties: true description: >- Fields that we will pass through to HRWorks's `Job Application` object. This API is used: https://developers.hrworks.de/docs/hrworks-api-v2/53021f035f62d-post-job-applications description: Fields specific to GuideCom. jobylon: type: object properties: application: type: object properties: message: type: string description: >- The `message` field of Jobylon's create application endpoint's request body. description: >- Fields that we will pass through to Jobylon's create application [endpoint](https://developer.jobylon.com/push-api-and-webhooks#-xL0v)'s request body. description: Fields specific to Jobylon. avature: type: object properties: workflow: type: object properties: step: type: object properties: id: type: integer format: int64 description: >- The ID of the workflow step to assign to the candidate. required: - id description: Fields specific to Avature. recruitee: type: object properties: candidate: type: object properties: cover_letter_text: type: string description: >- The cover letter text as a string. This will be visible on the main candidate page. Can be provided together with the `cover_letter` attachment, which will end up in a separate `file` section. description: Fields specific to Recruitee. rexx: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to Rexx's application form fields. description: Fields specific to Rexx. umantis: type: object properties: person: type: object additionalProperties: true description: >- Fields that we will pass through to Abacus Umantis's "Create a person" endpoint's `attributes` when creating a candidate. description: Fields specific to Abacus Umantis. piloga: type: object properties: candidate: type: object properties: street: type: string description: The street address of the candidate. description: >- Additional candidate fields for P&I Loga that will be mapped to the application form. description: Fields specific to P&I Loga. pinpoint: type: object properties: candidate: type: object additionalProperties: true description: >- Fields that we will pass through to Pinpoint's `Candidate` object. description: Fields specific to Pinpoint. covetorest: type: object properties: candidate: type: object properties: mandant: type: number format: double minimum: -1.7976931348623157e+308 description: The mandant field for the candidate in Coveto. status: type: integer format: int64 description: >- The numeric status ID to assign to the candidate on creation in Coveto. Refer to your Coveto `/bewerber-status` endpoint for available IDs. description: >- Additional candidate fields that will be passed to the Coveto candidate creation. description: Fields specific to Coveto REST. description: >- Additional fields that we will pass through to specific ATS systems. - type: object properties: greenhouse: type: object properties: post_headers: type: object properties: On-Behalf-Of: type: - string - 'null' description: >- ID of the the user that will show up as having performed the action in Greenhouse. We already pass a value by default, but you can use this to override it. description: Headers we will pass with `POST` requests to Greenhouse. description: Fields specific to Greenhouse. workable: type: object properties: on_behalf_of_user_remote_id: type: string description: >- The remote ID of the user that will be displayed in the UI as the one that performed the action. description: Workable specific remote fields for ATS actions. description: >- Additional fields that we will pass through to specific ATS systems. description: Additional fields that we will pass through to specific ATS systems. required: - candidate - application PostAtsCandidatesPositiveResponse: type: object properties: status: type: string const: success data: type: object properties: id: type: string description: >- The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. remote_id: type: string description: >- The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. first_name: type: - string - 'null' description: First name of the candidate. last_name: type: - string - 'null' description: Last name of the candidate. company: type: - string - 'null' description: The current company of the candidate. title: type: - string - 'null' description: The current job title of the candidate. confidential: type: - boolean - 'null' description: Whether the candidate’s profile is confidential in the ATS. source: type: - string - 'null' description: >- The hiring source of the candidate. If you're a job board or recruiting service, you can use this to validate which candidates applied through your service and ensure that the correct referral compensation is paid out. phone_numbers: type: - array - 'null' items: type: object properties: phone_number: type: string type: type: - string - 'null' description: >- Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to `null`. required: - phone_number default: [] description: A list of phone numbers of the candidate. email_addresses: type: - array - 'null' items: type: object properties: email_address: type: - string - 'null' pattern: >- ^(?!\.)(?!.*\.\.)([\w'+-.]*)[\w+-]@([\da-z][\da-z-]*\.)+[a-z]{2,}$ type: type: - string - 'null' description: >- Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to `null`. required: - type default: [] description: >- A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out. social_media: type: - array - 'null' items: type: object properties: link: type: - string - 'null' type: type: - string - 'null' username: type: - string - 'null' default: [] description: List of social media accounts of the candidate. location: type: - object - 'null' properties: city: type: - string - 'null' country: type: - string - 'null' description: >- Contains the ISO2 country code if possible. If not, it contains the original value. raw: type: - string - 'null' description: >- If we have address data, this is filled with the raw address string. state: type: - string - 'null' street_1: type: - string - 'null' description: >- If we can parse the address data, this field contains the first part of the street information. street_2: type: - string - 'null' zip_code: type: - string - 'null' description: Location of the candidate. custom_fields: type: - object - 'null' additionalProperties: true description: >- A key-value store of fields not covered by the schema. [Read more](/custom-fields) integration_fields: type: array items: type: object properties: id: type: string description: The globally unique ID of this object. key: type: string description: The key of the field in the remote system. type: type: string enum: - DEFAULT - CUSTOM description: |- - `DEFAULT`: static fields in the remote system. - `CUSTOM`: fields that are created/editable by the user. value: type: 'null' description: The field's value. label: type: - string - 'null' description: The label of the field. (not always available) required: - id - key - type - label description: >- An array of selected passthrough integration fields. [Read more](/integration-fields) examples: - - id: 5NVFhMpB9Ah6by44tzNjZLyE key: firstName type: DEFAULT value: Frank label: First Name - id: 8nuajYpoRd5GnxEQaaWKUDYQ key: customTshirtSize type: CUSTOM value: XL label: T-Shirt Size remote_url: type: - string - 'null' format: uri description: >- URL to the candidate profile in the source ATS system. When embedding this in your system, please consider that not for all ATS a dedicated candidate profile URL is available, so you might need to fall back to the application URL. remote_created_at: description: The date and time the object was created in the remote system. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_updated_at: description: >- A timestamp retrieved from the remote system, describing when the resource was last updated. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_data: type: - object - 'null' additionalProperties: true description: >- Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it. changed_at: description: >- The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated. type: string format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_deleted_at: description: >- The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString applications: type: array items: type: object properties: id: type: string description: >- The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. remote_id: type: - string - 'null' description: >- The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. outcome: type: - string - 'null' enum: - PENDING - HIRED - DECLINED description: >- Parsed status of the application. If Kombo identifies that the application was accepted and the candidate hired, it will be `HIRED`. If the application was rejected or the candidate declined, it will be `DECLINED`. If the application is still in process, it will be `PENDING`. Kombo will always try to deliver this information as reliably as possible. rejection_reason_name: type: - string - 'null' description: Reason for the rejection of the candidate. rejected_at: description: The time that the application was rejected. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_url: type: - string - 'null' format: uri description: >- URL to the application in the source ATS system. When embedding this in your system, please consider that not for all ATS a dedicated application URL is available, so you might need to fall back to the candidate URL. changed_at: description: >- The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated. type: string format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_created_at: description: >- The date and time the object was created in the remote system. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_updated_at: description: >- A timestamp retrieved from the remote system, describing when the resource was last updated. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString current_stage: type: - object - 'null' properties: id: type: string description: >- The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. name: type: - string - 'null' description: >- The application stage name. For example, "Initial Screening". remote_id: type: - string - 'null' description: >- The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. index: type: - integer - 'null' format: int64 examples: - 2 required: - id - name - remote_id - index job: type: - object - 'null' properties: id: type: string description: >- The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. name: type: - string - 'null' description: Title of the job. remote_id: type: string description: >- The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. required: - id - name - remote_id examples: - id: H5daSm8e85Dmvmne3wLeCPhX name: Backend Engineer remote_id: '32' required: - id - remote_id - outcome - rejection_reason_name - rejected_at - remote_url - changed_at - remote_created_at - remote_updated_at - current_stage - job tags: type: array items: type: object properties: id: type: string description: >- The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. name: type: - string - 'null' remote_id: type: - string - 'null' description: >- The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. required: - id - name - remote_id examples: - id: 26vafvWSRmbhNcxJYqjCzuJg name: High Potential remote_id: '32' required: - id - remote_id - first_name - last_name - company - title - confidential - source - custom_fields - integration_fields - remote_url - remote_created_at - remote_updated_at - remote_data - changed_at - remote_deleted_at - applications - tags examples: - id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe company: Acme, Inc. title: Head of Marketing confidential: false source: Employee Referral phone_numbers: - phone_number: +1-541-754-3010 type: HOME email_addresses: - email_address: john.doe@example.com type: PRIVATE social_media: - link: https://www.youtube.com/watch?v=dQw4w9WgXcQ type: YOUTUBE username: null location: city: Berlin country: DE raw: Berlin, Germany state: Berlin street_1: Lohmühlenstraße 65 street_2: null zip_code: '12435' custom_fields: {} integration_fields: [] remote_url: https://app.greenhouse.io/people/32 remote_created_at: '2022-04-02T00:00:00.000Z' remote_updated_at: '2022-04-04T00:00:00.000Z' remote_data: null changed_at: '2022-04-04T00:00:00.000Z' remote_deleted_at: null applications: - id: H77fDF8uvEzGNPRubiz5DvQ7 remote_id: '32' outcome: HIRED rejection_reason_name: null rejected_at: null remote_url: https://app.greenhouse.io/applications/32 changed_at: '2022-04-04T00:00:00.000Z' remote_created_at: '2022-04-02T00:00:00.000Z' remote_updated_at: '2022-04-04T00:00:00.000Z' current_stage: id: 5J7L4b48wBfffYwek9Az9pkM name: Initial Screening remote_id: '32' index: 2 job: id: H5daSm8e85Dmvmne3wLeCPhX name: Backend Engineer remote_id: '32' tags: - id: 26vafvWSRmbhNcxJYqjCzuJg name: High Potential remote_id: '32' warnings: type: array items: type: object properties: message: type: string required: - message description: >- These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. required: - status - data - warnings responses: ErrorResponseATS: description: The standard error response with the error codes for the ATS use case. content: application/json: schema: type: object properties: status: type: string enum: - error error: type: object properties: code: type: - string - 'null' enum: - PLATFORM.RATE_LIMIT_EXCEEDED - PLATFORM.CONCURRENCY_LIMIT_EXCEEDED - PLATFORM.INTEGRATION_NOT_FOUND - PLATFORM.INPUT_INVALID - PLATFORM.UNKNOWN_ERROR - PLATFORM.IP_NOT_WHITELISTED - PLATFORM.AUTHENTICATION_INVALID - PLATFORM.TASK_TIMED_OUT - INTEGRATION.PERMISSION_MISSING - INTEGRATION.AUTHENTICATION_INVALID - INTEGRATION.QA_FAILED - INTEGRATION.SETUP_SYNC_PENDING - INTEGRATION.SETUP_INCOMPLETE - INTEGRATION.INACTIVE - INTEGRATION.MODEL_NOT_AVAILABLE - INTEGRATION.MODEL_DISABLED - INTEGRATION.ACTION_NOT_AVAILABLE - INTEGRATION.ACTION_DISABLED - REMOTE.SERVICE_UNAVAILABLE - REMOTE.RATE_LIMIT_EXCEEDED - REMOTE.INPUT_INVALID - REMOTE.UNKNOWN_HTTP_ERROR - ATS.JOB_CLOSED - ATS.APPLICATION_ALREADY_EXISTS example: ATS.JOB_CLOSED description: >- Some errors include an error code that can be used to identify their cause. See the [Error Handling Docs](https://docs.kombo.dev/guides/errors) for more information. For your error handling logic please use the error `code` instead of other properties (e.g. message, http status code, ...). title: type: - string - 'null' description: A static, human-readable label. message: type: string description: >- A dynamic, detailed description of what went wrong in this specific instance. log_url: type: - string - 'null' format: uri description: >- The log page in the Kombo UI lists every interaction with full details. If you need assistance, share that link with our support team. required: - code - title - message - log_url description: Error details with structured code for programmatic handling. required: - status - error examples: Error Response: description: >- When building error handling logic, always use the `code` field to identify specific error types programmatically. See the complete list of error codes in the [docs](https://docs.kombo.dev/guides/errors). value: status: error error: code: INTEGRATION.MODEL_NOT_AVAILABLE title: >- This data model isn't supported for the selected integration. message: >- The "employees" model is not yet available for Greenhouse. Please reach out to Kombo if you need this functionality. log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456 Minimal Error Response: description: >- The "message" is always required while other fields can also be `null`. See the [docs](https://docs.kombo.dev/guides/errors) for more information. value: status: error error: code: null title: null message: The message is always in the response. log_url: null securitySchemes: ApiKey: type: http scheme: bearer description: >- Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard. ````