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 application
Create a new application and candidate 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 Kombo ID or Remote ID of the Job this candidate should apply for. 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. You can obtain the possible stage_id
s from the get-jobs
endpoint.
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.
Array of the attachments you would like to upload. The first CV in the attachments will be treated as the resume of the candidate when the tool allows previewing a resume.
(⚠️ 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 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.
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.
{
"status": "success",
"data": {
"id": "<string>",
"remote_id": "<string>",
"outcome": "PENDING",
"rejection_reason_name": "<string>",
"current_stage_id": "<string>",
"job_id": "<string>",
"candidate_id": "<string>",
"screening_question_answers": [
{
"answer": {
"content": "<string>"
},
"question": {
"remote_id": "<string>",
"title": "<string>",
"type": "TEXT"
}
}
],
"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"
}
],
"changed_at": "2023-11-07T05:31:56Z",
"remote_deleted_at": "2023-11-07T05:31:56Z",
"remote_created_at": "2023-11-07T05:31:56Z",
"remote_updated_at": "2023-11-07T05:31:56Z",
"remote_data": {},
"current_stage": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "Initial Screening",
"remote_id": "32"
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "Backend Engineer",
"remote_id": "32"
},
"candidate": {
"id": "<string>",
"remote_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"title": "<string>",
"confidential": true,
"source": "<string>",
"phone_numbers": [
{
"phone_number": "<string>",
"type": "<string>"
}
],
"email_addresses": [
{
"email_address": "jsmith@example.com",
"type": "<string>"
}
],
"social_media": [
{
"link": "<string>",
"type": "<string>",
"username": "<string>"
}
],
"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",
"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
- 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.
Visit our in depth guide to learn more about:
- 🌐 Setting the source of the application
- 📎 Uploading attachments with the application
- ♻️ Retry behaviour
- ✏️ Writing answers to screening questions
- ⚠️ Handling ATS-specific limitations
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"
}
},
"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
Create an API key on the Secrets page in the Kombo dashboard.
Headers
ID of the integration you want to interact with.
Path Parameters
The Kombo ID or Remote ID of the Job this candidate should apply for. 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.
Body
Stage this candidate should be in. If left out, the default stage for this job will be used. You can obtain the possible stage_id
s from the get-jobs
endpoint.
Array of the attachments you would like to upload. The first CV in the attachments will be treated as the resume of the candidate when the tool allows previewing a resume.
(⚠️ 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.
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.
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.
Response
success
{
"status": "success",
"data": {
"id": "<string>",
"remote_id": "<string>",
"outcome": "PENDING",
"rejection_reason_name": "<string>",
"current_stage_id": "<string>",
"job_id": "<string>",
"candidate_id": "<string>",
"screening_question_answers": [
{
"answer": {
"content": "<string>"
},
"question": {
"remote_id": "<string>",
"title": "<string>",
"type": "TEXT"
}
}
],
"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"
}
],
"changed_at": "2023-11-07T05:31:56Z",
"remote_deleted_at": "2023-11-07T05:31:56Z",
"remote_created_at": "2023-11-07T05:31:56Z",
"remote_updated_at": "2023-11-07T05:31:56Z",
"remote_data": {},
"current_stage": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "Initial Screening",
"remote_id": "32"
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "Backend Engineer",
"remote_id": "32"
},
"candidate": {
"id": "<string>",
"remote_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"title": "<string>",
"confidential": true,
"source": "<string>",
"phone_numbers": [
{
"phone_number": "<string>",
"type": "<string>"
}
],
"email_addresses": [
{
"email_address": "jsmith@example.com",
"type": "<string>"
}
],
"social_media": [
{
"link": "<string>",
"type": "<string>",
"username": "<string>"
}
],
"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",
"tags": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"name": "High Potential",
"remote_id": "32"
}
]
}
},
"warnings": [
{
"message": "<string>"
}
]
}