General
- Introduction
- Getting started
- Implementation guide
- FAQ
Features
Guides
ATS API Reference
- Jobs
- Applications
- Candidates
- Tags
- Users
- Offers
- Rejection reasons
General API Reference
- Kombo Connect
- Integrations
- Filtering
- Custom Fields
- Other
Create candidate
Create a new candidate and application for the specified job.
Create an API key on the Secrets page in the Kombo dashboard.
ID of the integration you want to interact with.
The first name of the candidate.
The last name of the candidate.
The primary email address this application will be created with.
The company where the candidate is currently working.
The current job title of the candidate.
The phone number of the candidate.
The location of the candidate.
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.
The gender of the candidate. Must be one of MALE, FEMALE, or OTHER.
The date the candidate is available to start working.
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.
The period of the salary expectations. Must be one of MONTH or YEAR.
The amount of the salary expectations.
A list of social media links of the candidate. The links must be valid URLs.
Currently, every candidate has one application. If you are interested in talent pools, please contact Kombo.
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 this candidate should be in. If left out, the default stage for this job will be used.
Array of answers to screening questions. Currently, not all question types are supported and unsupported ones will not be submitted.
The available questions a job can be retrieved from the get jobs endpoint. The answers will be validated based on the format of the the questions. Make sure to follow this schema to avoid errors.
An array of the attachments you would like upload.
(⚠️ Deprecated - Use automatic source writing 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.
Name of the source (e.g., "Example Job Board").
Optional GDPR consent information required in some jurisdictions (like the Czech Republic or Slovakia).
Until when the candidate has granted the company they're applying to permission to process their personal data.
Whether the candidate has given consent.
Additional fields that we will pass through to specific ATS systems.
Fields specific to SAP SuccessFactors.
Fields that we will pass through to SuccessFactor's Candidate object.
Fields that we will pass through to SuccessFactor's JobApplication object.
If set to true, we will copy custom attachments from the JobApplication to the Candidate.
When the candidate already exists, whether to update the Candidate with the remote fields found under the Candidate entity.
Fields specific to TalentSoft.
Fields that we will pass through to TalentSoft's applicant object.
Fields that we will pass through to TalentSoft's application object.
Fields that we will pass through to Teamtailor's Candidate object.
Fields specific to Greenhouse.
Fields that we will pass through to Greenhouse's Candidate object.
Fields that we will pass through to Greenhouse's Application object.
Headers we will pass with POST requests to Greenhouse.
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.
Fields specific to Lever.
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.
Fields specific to Workable.
Fields that we will pass through to Workable's Candidate object.
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.
Fields specific to Bullhorn.
Fields that we will pass through to Bullhorn's Candidate object.
Fields that we will pass through to Bullhorn's JobSubmission object.
Fields specific to SmartRecruiters.
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
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
Fields specific to Talentadore.
Fields that we will pass through to the Talentadore's when creating applications.
Fields specific to GuideCom.
Fields that we will pass through to GuideCom's Candidate object.
Fields specific to d.vinci.
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
{
"status": "success",
"data": {
"id": "<string>",
"remote_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"title": "<string>",
"confidential": true,
"source": "<string>",
"phone_numbers": [],
"email_addresses": [],
"social_media": [],
"location": {
"city": "<string>",
"country": "<string>",
"raw": "<string>",
"state": "<string>",
"street_1": "<string>",
"street_2": "<string>",
"zip_code": "<string>"
},
"custom_fields": {},
"integration_fields": [
{
"id": "5NVFhMpB9Ah6by44tzNjZLyE",
"key": "firstName",
"type": "DEFAULT",
"value": "Frank",
"label": "First Name"
},
{
"id": "8nuajYpoRd5GnxEQaaWKUDYQ",
"key": "customTshirtSize",
"type": "CUSTOM",
"value": "XL",
"label": "T-Shirt Size"
}
],
"remote_created_at": "2023-11-07T05:31:56Z",
"remote_updated_at": "2023-11-07T05:31:56Z",
"remote_data": {},
"changed_at": "2023-11-07T05:31:56Z",
"remote_deleted_at": "2023-11-07T05:31:56Z",
"applications": [
{
"id": "<string>",
"remote_id": "<string>",
"outcome": "PENDING",
"rejection_reason_name": "<string>",
"current_stage": {
"id": "<string>",
"name": "<string>",
"remote_id": "<string>",
"index": 2
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "Backend Engineer",
"remote_id": "32"
}
}
],
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "High Potential",
"remote_id": "32"
}
]
},
"warnings": [
{
"message": "<string>"
}
]
}This feature is currently available for the following integrations:
Workday
SAP SuccessFactors
SmartRecruiters
Factorial
Oracle Recruiting Cloud
Lever
iCIMS
Cornerstone TalentLink
Recruitee
Greenhouse
Greenhouse Job Board
Teamtailor
Ashby
CEGID TalentSoft FrontOffice
concludis
P&I Loga
Onlyfy
Personio
UKG Pro
rexx systems
AFAS Software
BambooHR
Bullhorn
Bullhorn Login
Workable
Jobvite
Fountain
Softgarden
Pinpoint
Welcome to the Jungle
d.vinci
JOIN
Sage HR
TRAFFIT
eRecruiter
Abacus Umantis
Haufe Umantis
Jobylon
Taleez
HRworks
OTYS
Zoho Recruit
Eploy
JobDiva
CareerPlug
Heyrecruit
RECRU
JazzHR
BITE
Homerun
Mysolution
Carerix
HR Office
Talent Clue
InRecruiting
Ubeeo
Connexys By Bullhorn
HR4YOU
Cornerstone OnDemand
Zvoove Recruit
Comeet
Compleet
Breezy HR
Flatchr
ReachMee
TalentAdore
Kombo Sandbox
GuideCom
You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.
This endpoint is deprecated!
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
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.
Example Request Body
{
"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"
},
"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": {}
}
Authorizations
Headers
ID of the integration you want to interact with.
Body
The first name of the candidate.
The last name of the candidate.
The primary email address this application will be created with.
The company where the candidate is currently working.
The current job title of the candidate.
The phone number of the candidate.
The location of the candidate.
The gender of the candidate. Must be one of MALE, FEMALE, or OTHER.
MALE, FEMALE, OTHER The date the candidate is available to start working.
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.
Currently, every candidate has one application. If you are interested in talent pools, please contact Kombo.
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 this candidate should be in. If left out, the default stage for this job will be used.
Array of answers to screening questions. Currently, not all question types are supported and unsupported ones will not be submitted.
The available questions a job can be retrieved from the get jobs endpoint. The answers will be validated based on the format of the the questions. Make sure to follow this schema to avoid errors.
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 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.
An array of the attachments you would like upload.
Name of the file you want to upload.
Content/MIME type of the file (e.g., application/pdf). This is required if you provide data and optional if you provide data_url.
Base64-encoded contents of the file you want to upload. You must provide either this or data_url.
Publicly accessible URL to the file you want to upload. You must provide either this or data.
CV, COVER_LETTER, OTHER (⚠️ Deprecated - Use automatic source writing 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.
Name of the source (e.g., "Example Job Board").
Optional GDPR consent information required in some jurisdictions (like the Czech Republic or Slovakia).
Additional fields that we will pass through to specific ATS systems.
Fields specific to SAP SuccessFactors.
Fields that we will pass through to SuccessFactor's Candidate object.
Fields that we will pass through to SuccessFactor's JobApplication object.
If set to true, we will copy custom attachments from the JobApplication to the Candidate.
When the candidate already exists, whether to update the Candidate with the remote fields found under the Candidate entity.
Fields specific to TalentSoft.
Fields that we will pass through to TalentSoft's applicant object.
Fields specific to Greenhouse.
Fields that we will pass through to Greenhouse's Candidate object.
Fields that we will pass through to Greenhouse's Application object.
Headers we will pass with POST requests to Greenhouse.
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.
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.
Fields specific to Bullhorn.
Fields that we will pass through to Bullhorn's Candidate object.
Fields specific to SmartRecruiters.
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
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
Response
success The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
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 of the candidate.
Last name of the candidate.
The current company of the candidate.
The current job title of the candidate.
Whether the candidate’s profile is confidential in the ATS.
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.
An array of selected pass-through integration fields. Read more
The globally unique ID of this object.
The key of the field in the remote system.
DEFAULT: static fields in the remote system.CUSTOM: fields that are created/editable by the user.
DEFAULT, CUSTOM The field's value.
The label of the field. (not always available)
The date and time the object was created in the remote system.
A timestamp retrieved from the remote system, describing when the resource was last updated.
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.
The timestamp when this object was last changed. This value is tracked by Kombo based on changes in the data.
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.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
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.
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.
PENDING, HIRED, DECLINED Reason for the rejection of the candidate.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
The application stage name. For example, "Initial Screening".
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.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
Title of the job.
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.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
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.
A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out.
Location of the candidate.
Contains the ISO2 country code if possible. If not, it contains the original value.
If we have address data, this is filled with the raw address string.
If we can parse the address data, this field contains the first part of the street information.
{
"status": "success",
"data": {
"id": "<string>",
"remote_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"title": "<string>",
"confidential": true,
"source": "<string>",
"phone_numbers": [],
"email_addresses": [],
"social_media": [],
"location": {
"city": "<string>",
"country": "<string>",
"raw": "<string>",
"state": "<string>",
"street_1": "<string>",
"street_2": "<string>",
"zip_code": "<string>"
},
"custom_fields": {},
"integration_fields": [
{
"id": "5NVFhMpB9Ah6by44tzNjZLyE",
"key": "firstName",
"type": "DEFAULT",
"value": "Frank",
"label": "First Name"
},
{
"id": "8nuajYpoRd5GnxEQaaWKUDYQ",
"key": "customTshirtSize",
"type": "CUSTOM",
"value": "XL",
"label": "T-Shirt Size"
}
],
"remote_created_at": "2023-11-07T05:31:56Z",
"remote_updated_at": "2023-11-07T05:31:56Z",
"remote_data": {},
"changed_at": "2023-11-07T05:31:56Z",
"remote_deleted_at": "2023-11-07T05:31:56Z",
"applications": [
{
"id": "<string>",
"remote_id": "<string>",
"outcome": "PENDING",
"rejection_reason_name": "<string>",
"current_stage": {
"id": "<string>",
"name": "<string>",
"remote_id": "<string>",
"index": 2
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "Backend Engineer",
"remote_id": "32"
}
}
],
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "High Potential",
"remote_id": "32"
}
]
},
"warnings": [
{
"message": "<string>"
}
]
}