Candidates
TheCandidate
object is used to represent a Candidate for various positions.The Candidate object
Properties
id
Stringremote_id
Stringfirst_name
Stringlast_name
Stringcompany
Stringtitle
Stringremote_created_at
Stringremote_updated_at
Stringlast_interaction_at
Stringis_private
Booleancan_email
Booleanlocations
Arrayphone_numbers
PhoneNumber[]The PhoneNumber object
PhoneNumber
object is used to represent a candidate's phone number.{"value": "+3198675309","phone_number_type": "HOME"}
Properties
value
Stringphone_number_type
EnumHOME
, WORK
, MOBILE
, SKYPE
, OTHER
, or - in cases where there is no clear mapping - the original value passed through.email_addresses
EmailAddress[]The EmailAddress object
EmailAddress
object is used to represent a candidate's email address.Properties
value
Stringemail_address_type
EnumPERSONAL
, WORK
, OTHER
, or - in cases where there is no clear mapping - the original value passed through.urls
Url[]The Url object
Url
object is used to represent a candidate's website.{"value": "http://alturl.com/p749b","url_type": "PERSONAL"}
Properties
value
Stringurl_type
EnumPERSONAL
, COMPANY
, PORTFOLIO
, BLOG
, SOCIAL_MEDIA
, OTHER
, or - in cases where there is no clear mapping - the original value passed through.tags
ArrayTag
names as strings.applications
ArrayApplication
object IDs.attachments
ArrayAttachment
object IDs.custom_fields
Objectremote_was_deleted
Boolean{"id": "521b18c2-4d01-4297-b451-19858d07c133","remote_id": "21198","first_name": "Gil","last_name": "Feig","company": "Columbia Dining App.","title": "Software Engineer","remote_created_at": "2021-10-15T00:00:00Z","remote_updated_at": "2021-10-16T00:00:00Z","last_interaction_at": "2021-10-17T00:00:00Z","is_private": true,"can_email": true,"locations": ["San Francisco","New York","Miami"],"phone_numbers": [{"value": "+1234567890","phone_number_type": "MOBILE"}],"email_addresses": [{"value": "[email protected]","email_address_type": "PERSONAL"}],"urls": [{"value": "http://alturl.com/p749b","url_type": "BLOG"}],"tags": ["High-Priority"],"applications": ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],"attachments": ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],"custom_fields": {},"remote_was_deleted": true}
/candidates
Returns a list of Candidate
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringexpand
Stringfirst_name
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanlast_name
Stringmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "521b18c2-4d01-4297-b451-19858d07c133","remote_id": "21198","first_name": "Gil","last_name": "Feig","company": "Columbia Dining App.","title": "Software Engineer","remote_created_at": "2021-10-15T00:00:00Z","remote_updated_at": "2021-10-16T00:00:00Z","last_interaction_at": "2021-10-17T00:00:00Z","is_private": true,"can_email": true,"locations": ["San Francisco","New York","Miami"],"phone_numbers": [{"value": "+1234567890","phone_number_type": "MOBILE"}],"email_addresses": [{"value": "[email protected]","email_address_type": "PERSONAL"}],"urls": [{"value": "http://alturl.com/p749b","url_type": "BLOG"}],"tags": ["High-Priority"],"applications": ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],"attachments": ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],"custom_fields": {},"remote_was_deleted": true}]}

SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
title
Stringlast_name
Stringlocations
Arrayfirst_name
Stringcompany
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Fountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringlocations
Arrayfirst_name
Stringcan_email
Booleanremote_created_at
Stringremote_id
Stringremote_updated_at
String
JazzHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringlocations
Arrayfirst_name
Stringremote_created_at
Stringremote_id
String
Breezy HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringfirst_name
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
ApplicantStack
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraylast_name
Stringfirst_name
Stringremote_created_at
Stringremote_id
String
Ashby
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
title
Stringlast_name
Stringfirst_name
Stringcompany
Stringremote_id
String
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
is_private
Booleantitle
Stringlast_name
Stringlocations
Arrayfirst_name
Stringcompany
Stringlast_interaction_at
Stringcan_email
Booleanremote_created_at
Stringremote_id
Stringremote_updated_at
String
Comeet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraylast_name
Stringfirst_name
Stringlast_interaction_at
Stringremote_created_at
Stringremote_id
String
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringlocations
Arrayfirst_name
Stringlast_interaction_at
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
is_private
Booleanlocations
Arraylast_name
Stringtitle
Stringfirst_name
Stringcompany
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Teamtailor
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraylast_name
Stringfirst_name
Stringcan_email
Booleanremote_created_at
Stringremote_id
Stringremote_updated_at
String
CATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraylast_name
Stringtitle
Stringfirst_name
Stringcompany
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Cornerstone TalentLink
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraylast_name
Stringfirst_name
Stringlast_interaction_at
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Clockwork
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringtitle
Stringlocations
Arrayfirst_name
Stringcompany
Stringcan_email
Booleanremote_created_at
Stringremote_id
Stringremote_updated_at
String
TalentLyft
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraylast_name
Stringtitle
Stringfirst_name
Stringcompany
Stringlast_interaction_at
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
is_private
Booleanlocations
Arraylast_name
Stringfirst_name
Stringlast_interaction_at
Stringcompany
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Sage HR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringlocations
Arrayfirst_name
Stringremote_created_at
Stringremote_id
String
Jobscore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringtitle
Stringlocations
Arrayfirst_name
Stringcompany
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Recruiterflow
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringlocations
Arraytitle
Stringfirst_name
Stringcompany
Stringlast_interaction_at
Stringcan_email
Booleanremote_created_at
Stringremote_id
Stringremote_updated_at
String
BizMerlinHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringfirst_name
Stringremote_id
String
Workable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
title
Stringlast_name
Stringlocations
Arrayfirst_name
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Homerun
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringfirst_name
Stringremote_created_at
Stringremote_id
String
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringfirst_name
Stringremote_id
Stringremote_updated_at
String
Lano
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
last_name
Stringfirst_name
Stringremote_id
String
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
is_private
Booleanlocations
Arraylast_name
Stringtitle
Stringfirst_name
Stringlast_interaction_at
Stringcan_email
Booleanremote_created_at
Stringremote_id
Stringremote_updated_at
String
Jobvite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraytitle
Stringlast_name
Stringfirst_name
Stringcompany
Stringremote_id
String
BambooHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraylast_name
Stringfirst_name
Stringremote_id
String
Workday
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
locations
Arraylast_name
Stringtitle
Stringfirst_name
Stringcompany
Stringremote_id
String/candidates
Creates a Candidate
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
Objectremote_user_id
StringModel Parameters
remote_id
Stringfirst_name
Stringlast_name
Stringcompany
Stringtitle
Stringremote_created_at
Stringremote_updated_at
Stringlast_interaction_at
Stringis_private
Booleancan_email
Booleanlocations
Arrayphone_numbers
Arrayemail_addresses
Arrayurls
Arraytags
ArrayTag
names as strings.applications
ArrayApplication
object IDs.attachments
ArrayAttachment
object IDs.custom_fields
Objectremote_template_id
Stringintegration_params
Objectlinked_account_params
Object{"model": {"id": "521b18c2-4d01-4297-b451-19858d07c133","remote_id": "21198","first_name": "Gil","last_name": "Feig","company": "Columbia Dining App.","title": "Software Engineer","remote_created_at": "2021-10-15T00:00:00Z","remote_updated_at": "2021-10-16T00:00:00Z","last_interaction_at": "2021-10-17T00:00:00Z","is_private": true,"can_email": true,"locations": ["San Francisco","New York","Miami"],"phone_numbers": [{"value": "+1234567890","phone_number_type": "MOBILE"}],"email_addresses": [{"value": "[email protected]","email_address_type": "PERSONAL"}],"urls": [{"value": "http://alturl.com/p749b","url_type": "BLOG"}],"tags": ["High-Priority"],"applications": ["29eb9867-ce2a-403f-b8ce-f2844b89f078","b4d08e5c-de00-4d64-a29f-66addac9af99","4ff877d2-fb3e-4a5b-a7a5-168ddf2ffa56"],"attachments": ["bea08964-32b4-4a20-8bb4-2612ba09de1d"],"custom_fields": {},"remote_was_deleted": true},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}

SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
last_name
Stringtitle
Stringlocations
Arrayfirst_name
Stringcompany
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Fountain
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
last_name
Stringfirst_name
Stringlast_interaction_at
Stringcan_email
Booleanremote_created_at
Stringremote_id
Stringremote_updated_at
String
JazzHR
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
locations
Arraylast_name
Stringfirst_name
Stringcompany
Stringcan_email
Booleanremote_id
String
Breezy HR
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
last_name
Stringfirst_name
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Ashby
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
first_name
Stringremote_id
Stringlast_name
String
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
is_private
Booleanlocations
Arraytitle
Stringlast_name
Stringfirst_name
Stringlast_interaction_at
Stringcompany
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
locations
Arraylast_name
Stringfirst_name
Stringlast_interaction_at
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
first_name
Stringremote_id
Stringlast_name
String
Teamtailor
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
last_name
Stringfirst_name
Stringcan_email
Booleanremote_created_at
Stringremote_id
Stringremote_updated_at
String
Cornerstone TalentLink
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
last_name
Stringfirst_name
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Lever
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
locations
Arraylast_name
Stringfirst_name
Stringremote_updated_at
Stringlast_interaction_at
Stringremote_created_at
Stringremote_id
String
UKG Pro Recruiting
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
last_name
Stringtitle
Stringfirst_name
Stringcompany
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Workable
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
title
Stringlast_name
Stringfirst_name
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
String
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
is_private
Booleanlast_name
Stringtitle
Stringlocations
Arrayfirst_name
Stringlast_interact