Use this file to discover all available pages before exploring further.
The SmartRecruiters ATS integration allows you to sync ATS data between SmartRecruiters and your application through Kombo’s unified API. The tool slug for this connector is smartrecruiters.
SmartRecruiters does not validate email addresses. Kombo will sync all users, but only return emails that have been validated.
Field
Notes
id
remote_id
changed_at
remote_deleted_at
first_name
last_name
email
status
remote_data
Jobs
Field
Notes
id
remote_id
changed_at
remote_deleted_at
name
job_code
description
employment_type
status
visibility
category
department
post_url
experience_level
salary_amount_from
salary_amount_to
salary_currency
salary_period
location
custom_fields
integration_fields
remote_url
opened_at
remote_created_at
remote_updated_at
remote_data
Job postings
Field
Notes
id
remote_id
changed_at
remote_deleted_at
title
description_html
status
visibility
url
job_id
remote_data
remote_created_at
Candidates
Field
Notes
id
remote_id
changed_at
remote_deleted_at
first_name
last_name
company
title
source
phone_numbers
email_addresses
social_media
location
custom_fields
integration_fields
remote_url
remote_created_at
remote_updated_at
remote_data
Application Stages
SmartRecruiters will continue to reference inactive or deleted application stages
Field
Notes
id
remote_id
changed_at
remote_deleted_at
name
global_index
Applications
Field
Notes
id
remote_id
changed_at
remote_deleted_at
outcome
rejection_reason_name
rejected_at
current_stage_id
job_id
candidate_id
screening_question_answers
custom_fields
integration_fields
remote_url
remote_created_at
The remote_created_at field will only be filled when we are syncing the application status history which we are doing to sync rejected_at.
remote_updated_at
The remote_updated_at field will only be filled when we are syncing the application status history which we are doing to sync rejected_at. Furthermore, it only reflects changes to the application status, not the application itself.
remote_data
Screening questions
Field
Notes
id
remote_id
changed_at
remote_deleted_at
title
description
format
category
Tags
SmartRecruiters API only provides access to tags that are currently assigned to candidates. This means Kombo can only retrieve tags that are attached to specific candidates, rather than providing a complete list of all available tags in the SmartRecruiters system.
Field
Notes
id
remote_id
changed_at
remote_deleted_at
name
Interviews
Field
Notes
id
remote_id
changed_at
remote_deleted_at
title
starting_at
ending_at
location
application_id
canceled
remote_data
Offers
Field
Notes
id
remote_id
changed_at
remote_deleted_at
status
application_id
The SmartRecruiters offer model only contains references to the candidate and job. If application_id is enabled in your Kombo scope config, we therefore additionally request the application read scope to retrieve the application ID from the candidate and job.
custom_fields
integration_fields
remote_created_at
remote_updated_at
remote_data
Rejection reasons
Field
Notes
id
remote_id
changed_at
remote_deleted_at
name
remote_data
Roles
Field
Notes
id
remote_id
changed_at
remote_deleted_at
remote_label
scope
unified_type
Candidate tags
Field
Notes
candidate_id
tag_id
id
changed_at
remote_deleted_at
Job-specific application stages
Field
Notes
index
job_id
stage_id
id
changed_at
remote_deleted_at
Job-specific screening questions
Field
Notes
index
required
precondition_question_id
precondition_options
job_id
question_id
id
changed_at
remote_deleted_at
Job user role assignments
Smartrecruiters exposes a list of hiring team members with a specific role
HIRING_MANAGER (shown as “Hiring Manager” in the UI) maps to unified type HIRING_MANAGER
RECRUITER (shown as “Recruiter” in the UI) maps to unified type RECRUITER
INTERVIEW_TEAM (shown as “Interviewer” in the UI) maps to unified type INTERVIEWER
COORDINATOR (shown as “Coordinator” in the UI) maps to unified type COORDINATOR
EXECUTIVE (shown as “Executive” in the UI) has no unified type
Other role values (often a custom id) have no unified type
Field
Notes
job_user_id
role_id
id
changed_at
remote_deleted_at
Job hiring team members
Field
Notes
roles
job_id
user_id
id
changed_at
remote_deleted_at
User roles
Each user has systemRole.id; Kombo stores that value on the role. Custom ids use the name from the synced system-roles resource when available, otherwise the raw id.
ADMINISTRATOR maps to unified type ADMIN
EMPLOYEE, STANDARD, and EXTENDED have no unified type
RESTRICTED corresponds to the Basic role in the SmartRecruiters UI and has no unified type
Any other systemRole.id follows the custom-role lookup above and has no unified type.
Field
Notes
user_id
role_id
id
changed_at
remote_deleted_at
Interviewing team members
Field
Notes
interview_id
user_id
id
changed_at
remote_deleted_at
Create candidate
The read_jobs permission is required because we need to look up job posting details when creating candidates. SmartRecruiters does not allow setting a stage directly when creating a candidate. Passing the stage_id parameter to Kombo when creating a candidate will therefore move the candidate to the stage post-creation, and requires the candidate_manage SmartRecruiters permission. Past candidate experience must be defined with a start date and title within the SmartRecruiters API. Kombo will set the title to ’-’ if only the company field is passed without a title. The start date is set to 2100-01-01 as a dummy value; if you require a different start date, please set it via remote_fields.
Input Field
Notes
candidate.first_name
candidate.last_name
candidate.email_address
candidate.company
candidate.title
candidate.phone_number
candidate.location.city
candidate.location.country
candidate.social_links.url
application.job_id
application.stage_id
screening_question_answers.question_id
screening_question_answers.answer
attachments.name
attachments.content_type
attachments.data_url
attachments.data
attachments.type
source.name
Please note that we can only write sources that your customer has already set up with the exact name (under www.smartrecruiters.com/settings/configuration/custom-sources). If you specify a source within the source.name field, we will only use it if it’s already set up within SmartRecruiters and is of the type ‘OTHER’. Otherwise, the source defined in the connection flow is used.
source.unified_key
source.id
gdpr_consent.given
Create application
The read_jobs permission is required because we need to look up job posting details when creating candidates. SmartRecruiters does not allow setting a stage directly when creating a candidate. Passing the stage_id parameter to Kombo when creating a candidate will therefore move the candidate to the stage post-creation, and requires the candidate_manage SmartRecruiters permission. Past candidate experience must be defined with a start date and title within the SmartRecruiters API. Kombo will set the title to ’-’ if only the company field is passed without a title. The start date is set to 2100-01-01 as a dummy value; if you require a different start date, please set it via remote_fields.
Input Field
Notes
candidate.first_name
candidate.last_name
candidate.email_address
candidate.company
candidate.title
candidate.phone_number
candidate.location.city
candidate.location.country
candidate.social_links.url
application.job_id
application.stage_id
screening_question_answers.question_id
screening_question_answers.answer
attachments.name
attachments.content_type
attachments.data_url
attachments.data
attachments.type
source.name
Please note that we can only write sources that your customer has already set up with the exact name (under www.smartrecruiters.com/settings/configuration/custom-sources). If you specify a source within the source.name field, we will only use it if it’s already set up within SmartRecruiters and is of the type ‘OTHER’. Otherwise, the source defined in the connection flow is used.
source.unified_key
source.id
gdpr_consent.given
Add tag to candidate
Input Field
Notes
candidate_id
tag.name
Remove tag from candidate
Input Field
Notes
candidate_id
tag.name
Add attachment to application
The SmartRecruiters ‘add attachment to candidate’ endpoint is deprecated. Please prefer to use Kombo’s ‘add attachment to application’ endpoint.
Input Field
Notes
application_id
attachment.name
attachment.content_type
attachment.data_url
attachment.data
attachment.type
Move application to stage
Input Field
Notes
application_id
stage_id
Reject application
Input Field
Notes
application_id
rejection_reason_id
Add result link to application
Input Field
Notes
application_id
label
url
details.attributes.key
details.attributes.value
Add note to application
Input Field
Notes
application_id
content
Get application attachments
Input Field
Notes
application_id
Get candidate attachments
Input Field
Notes
candidate_id
Add attachment to candidate
The SmartRecruiters ‘add attachment to candidate’ endpoint is deprecated. Please prefer to use Kombo’s ‘add attachment to application’ endpoint.
Input Field
Notes
candidate_id
attachment.name
attachment.content_type
attachment.data_url
attachment.data
attachment.type
Add result link to candidate
Input Field
Notes
candidate_id
label
url
details.attributes.key
details.attributes.value
Feature
Notes
Source Writing
Sync Only Created Applications
Connection Guide
Prerequisites
Candidate source tracking
Candidate Cutoff Filtering
Roles
System roles (e.g. Admin)
Each user has systemRole.id; Kombo stores that value on the role. Custom ids use the name from the synced system-roles resource when available, otherwise the raw id.
ADMINISTRATOR maps to unified type ADMIN
EMPLOYEE, STANDARD, and EXTENDED have no unified type
RESTRICTED corresponds to the Basic role in the SmartRecruiters UI and has no unified type
Any other systemRole.id follows the custom-role lookup above and has no unified type. |
| Job roles (e.g. Hiring Manager) | Smartrecruiters exposes a list of hiring team members with a specific role
HIRING_MANAGER (shown as “Hiring Manager” in the UI) maps to unified type HIRING_MANAGER
RECRUITER (shown as “Recruiter” in the UI) maps to unified type RECRUITER
INTERVIEW_TEAM (shown as “Interviewer” in the UI) maps to unified type INTERVIEWER
COORDINATOR (shown as “Coordinator” in the UI) maps to unified type COORDINATOR
EXECUTIVE (shown as “Executive” in the UI) has no unified type
Other role values (often a custom id) have no unified type |
| OAuth | |
| API Passthrough | |
| Webhook Subscriptions | application.created: triggered when an application was created application.fields.updated: triggered when application fields were updated application.onboarding-status.updated: triggered when application onboarding status was updated application.screening-answers.created: triggered when screening question answers were added to an application application.screening-answers.updated: triggered when screening question answers were updated on an application application.source.updated: triggered when the source of the application was updated application.status.updated: triggered when the status (stage) of an application was changed candidate.created: triggered when a candidate was created candidate.updated: triggered when a candidate was updated including tag assigned/unassigned interview.created: triggered when an interview was scheduled interview.updated: triggered when an interview was updated candidate.deleted: triggered when a candidate was deleted interview.canceled: triggered when an interview was canceled job.ad.created: triggered when a job ad was created job.ad.updated: triggered when a job ad was updated job.ad.postings.updated: triggered when the postings of a job ad were updated, including job ad being published or unpublished job.created: triggered when a job was created job.hiring-team.updated: triggered when the hiring team was updated on a job job.status.updated: triggered when the status of a job was updated job.updated: triggered when a job was updated offer.created: triggered when an offer was created offer.updated: triggered when an offer was updated Not covered: screening questions were updated for a job |
| Automatic Setup | |
| Scope Testing | |
| Delta Syncs | |
| Custom Field Explorer | |
| Candidates | |
| EEO Questions | |
