Candidates

The Candidate object is used to represent a Candidate for various positions.

The Candidate object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

first_nameString
Optional
The candidate's first name.

last_nameString
Optional
The candidate's last name.

companyString
Optional
The candidate's current company.

titleString
Optional
The candidate's current title.

remote_created_atString
Optional
When the third party's candidate was created.

remote_updated_atString
Optional
When the third party's candidate was updated.

last_interaction_atString
Optional
When the most recent candidate interaction occurred.

is_privateBoolean
Optional
Whether or not the candidate is private.

can_emailBoolean
Optional
Whether or not the candidate can be emailed.

locationsArray
Optional
The candidate's locations.

phone_numbersPhoneNumber[]
Required

The PhoneNumber object

The PhoneNumber object is used to represent a candidate's phone number.
{
"value": "+3198675309",
"phone_number_type": "HOME"
}

Properties


valueString
Optional
The phone number.

phone_number_typeEnum
Optional
The type of phone number. Possible values include: HOME, WORK, MOBILE, SKYPE, OTHER, or - in cases where there is no clear mapping - the original value passed through.

email_addressesEmailAddress[]
Required

The EmailAddress object

The EmailAddress object is used to represent a candidate's email address.
{
"value": "[email protected]",
"email_address_type": "PERSONAL"
}

Properties


valueString
Optional
The email address.

email_address_typeEnum
Optional
The type of email address. Possible values include: PERSONAL, WORK, OTHER, or - in cases where there is no clear mapping - the original value passed through.

urlsUrl[]
Required

The Url object

The Url object is used to represent a candidate's website.
{
"value": "http://alturl.com/p749b",
"url_type": "PERSONAL"
}

Properties


valueString
Optional
The site's url.

url_typeEnum
Optional
The type of site. Possible values include: PERSONAL, COMPANY, PORTFOLIO, BLOG, SOCIAL_MEDIA, OTHER, or - in cases where there is no clear mapping - the original value passed through.

tagsArray
Required
Array of Tag names as strings.

applicationsArray
Required
Array of Application object IDs.

attachmentsArray
Required
Array of Attachment object IDs.

custom_fieldsObject
Optional
Custom fields configured for a given model.

remote_was_deletedBoolean
Required

The Candidate object
JSON
{
"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
}

GET

/candidates

Returns a list of Candidate objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

first_nameString
Optional
If provided, will only return candidates with this first name.

include_deleted_dataBoolean
Optional
Whether to include data that was deleted in the third-party service.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

last_nameString
Optional
If provided, will only return candidates with this last name.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"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
}
]
}
Field support by platform

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


titleString

last_nameString

locationsArray

first_nameString

companyString

remote_created_atString

remote_idString

remote_updated_atString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

locationsArray

first_nameString

can_emailBoolean

remote_created_atString

remote_idString

remote_updated_atString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

locationsArray

first_nameString

remote_created_atString

remote_idString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

first_nameString

remote_created_atString

remote_idString

remote_updated_atString

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

last_nameString

first_nameString

remote_created_atString

remote_idString

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


titleString

last_nameString

first_nameString

companyString

remote_idString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


is_privateBoolean

titleString

last_nameString

locationsArray

first_nameString

companyString

last_interaction_atString

can_emailBoolean

remote_created_atString

remote_idString

remote_updated_atString

Comeet

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

last_nameString

first_nameString

last_interaction_atString

remote_created_atString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

locationsArray

first_nameString

last_interaction_atString

remote_created_atString

remote_idString

remote_updated_atString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


is_privateBoolean

locationsArray

last_nameString

titleString

first_nameString

companyString

remote_created_atString

remote_idString

remote_updated_atString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

last_nameString

first_nameString

can_emailBoolean

remote_created_atString

remote_idString

remote_updated_atString

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

last_nameString

titleString

first_nameString

companyString

remote_created_atString

remote_idString

remote_updated_atString

Cornerstone TalentLink

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

last_nameString

first_nameString

last_interaction_atString

remote_created_atString

remote_idString

remote_updated_atString

Clockwork

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

titleString

locationsArray

first_nameString

companyString

can_emailBoolean

remote_created_atString

remote_idString

remote_updated_atString

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

last_nameString

titleString

first_nameString

companyString

last_interaction_atString

remote_created_atString

remote_idString

remote_updated_atString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


is_privateBoolean

locationsArray

last_nameString

first_nameString

last_interaction_atString

companyString

remote_created_atString

remote_idString

remote_updated_atString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

locationsArray

first_nameString

remote_created_atString

remote_idString

Jobscore

Jobscore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

titleString

locationsArray

first_nameString

companyString

remote_created_atString

remote_idString

remote_updated_atString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

locationsArray

titleString

first_nameString

companyString

last_interaction_atString

can_emailBoolean

remote_created_atString

remote_idString

remote_updated_atString

BizMerlinHR

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

first_nameString

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


titleString

last_nameString

locationsArray

first_nameString

remote_created_atString

remote_idString

remote_updated_atString

Homerun

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

first_nameString

remote_created_atString

remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

first_nameString

remote_idString

remote_updated_atString

Lano

Lano

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


last_nameString

first_nameString

remote_idString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


is_privateBoolean

locationsArray

last_nameString

titleString

first_nameString

last_interaction_atString

can_emailBoolean

remote_created_atString

remote_idString

remote_updated_atString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

titleString

last_nameString

first_nameString

companyString

remote_idString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

last_nameString

first_nameString

remote_idString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


locationsArray

last_nameString

titleString

first_nameString

companyString

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST

/candidates

Creates a Candidate object with the given values.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters


modelObject
Required
Find available fields below under “Model Parameters”.

remote_user_idString
Required

Model Parameters


remote_idString
Optional
The third-party API ID of the matching object.

first_nameString
Optional
The candidate's first name.

last_nameString
Optional
The candidate's last name.

companyString
Optional
The candidate's current company.

titleString
Optional
The candidate's current title.

remote_created_atString
Optional
When the third party's candidate was created.

remote_updated_atString
Optional
When the third party's candidate was updated.

last_interaction_atString
Optional
When the most recent candidate interaction occurred.

is_privateBoolean
Optional
Whether or not the candidate is private.

can_emailBoolean
Optional
Whether or not the candidate can be emailed.

locationsArray
Optional
The candidate's locations.

phone_numbersArray
Required

email_addressesArray
Required

urlsArray
Required

tagsArray
Required
Array of Tag names as strings.

applicationsArray
Required
Array of Application object IDs.

attachmentsArray
Required
Array of Attachment object IDs.

custom_fieldsObject
Optional
Custom fields configured for a given model.

remote_template_idString
Optional

integration_paramsObject
Optional

linked_account_paramsObject
Optional

Response
JSON
{
"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
}
}
]
}
Field support by platform

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


last_nameString
Required

titleString
Optional

locationsArray
Optional

first_nameString
Required

companyString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


last_nameString
Optional

first_nameString
Required

last_interaction_atString
Optional

can_emailBoolean
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


locationsArray
Optional

last_nameString
Required

first_nameString
Required

companyString
Optional

can_emailBoolean
Optional

remote_idString
Optional

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


last_nameString
Optional

first_nameString
Required

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


first_nameString
Required

remote_idString
Optional

last_nameString
Required

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Required

Supported POST Body Parameters


is_privateBoolean
Optional

locationsArray
Optional

titleString
Optional

last_nameString
Required

first_nameString
Required

last_interaction_atString
Optional

companyString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


locationsArray
Optional

last_nameString
Optional

first_nameString
Optional

last_interaction_atString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


first_nameString
Required

remote_idString
Optional

last_nameString
Required

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


last_nameString
Optional

first_nameString
Optional

can_emailBoolean
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Cornerstone TalentLink

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


last_nameString
Optional

first_nameString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Required

Supported POST Body Parameters


locationsArray
Optional

last_nameString
Required

first_nameString
Required

remote_updated_atString
Optional

last_interaction_atString
Optional

remote_created_atString
Optional

remote_idString
Optional

UKG Pro Recruiting

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


last_nameString
Required

titleString
Optional

first_nameString
Required

companyString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


titleString
Optional

last_nameString
Required

first_nameString
Required

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


is_privateBoolean
Optional

last_nameString
Optional

titleString
Optional

locationsArray
Optional

first_nameString
Optional

last_interact