Candidates

The Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.

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 interaction with the candidate 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.
JSON
{
"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.
JSON
{
"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 hyperlinks associated with the parent model.
JSON
{
"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, JOB_POSTING, or - in cases where there is no clear mapping - the original value passed through.

tagsArray
Required
Array of Tag names as strings.

applicationsApplication[]
Required
Array of Application object IDs.

The Application object

The Application Object is used to represent a candidate's journey through a particular Job's recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it.
JSON
{
"id": "92e8a369-fffe-430d-b93a-f7e8a16563f1",
"remote_id": "98796",
"candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
"job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
"applied_at": "2021-10-15T00:00:00Z",
"rejected_at": "2021-11-15T00:00:00Z",
"source": "Campus recruiting event",
"credited_to": "58166795-8d68-4b30-9bfb-bfd402479484",
"current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea",
"reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784",
"remote_data": [
{
"path": "/candidacies",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}

Properties


idString
Required

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

candidateString
Optional
The candidate applying.

jobString
Optional
The job being applied for.

applied_atString
Optional
When the application was submitted.

rejected_atString
Optional
When the application was rejected.

sourceString
Optional
The application's source.

credited_toString
Optional
The user credited for this application.

current_stageString
Optional
The application's current stage.

reject_reasonString
Optional
The application's reason for rejection.

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required

field_mappingsObject
Optional

attachmentsAttachment[]
Required
Array of Attachment object IDs.

The Attachment object

The Attachment object is used to represent a file attached to a candidate.
JSON
{
"id": "c640b80b-fac9-409f-aa19-1f9221aec445",
"remote_id": "11167",
"file_name": "Candidate Resume",
"file_url": "http://alturl.com/p749b",
"candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
"attachment_type": "RESUME",
"remote_data": [
{
"path": "/attachments",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}

Properties


idString
Required

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

file_nameString
Optional
The attachment's name.

file_urlString
Optional
The attachment's url.

candidateString
Optional

attachment_typeEnum
Optional
The attachment's type. Possible values include: RESUME, COVER_LETTER, OFFER_LETTER, OTHER, or - in cases where there is no clear mapping - the original value passed through.

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required

field_mappingsObject
Optional

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"
],
"remote_data": [
{
"path": "/candidates",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}

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.

email_addressesString
Optional
If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas.

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 marked as deleted by third party webhooks.

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.

tagsString
Optional
If provided, will only return candidates with these tags; multiple tags can be separated by commas.

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"
],
"remote_data": [
{
"path": "/candidates",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
}
]
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring
email_address_typestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

urlsUrl[]
valuestring
url_typestring

companyString

first_nameString

last_nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

titleString

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

first_nameString

last_nameString

locationsArray

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

BizMerlinHR

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


first_nameString

last_nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Breezy

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

first_nameString

last_nameString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

urlsUrl[]
valuestring
url_typestring

companyString

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

Clockwork

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring
email_address_typestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

urlsUrl[]
valuestring
url_typestring

can_emailBoolean

companyString

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

Comeet

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

first_nameString

last_nameString

locationsArray

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Cornerstone TalentLink

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring
email_address_typestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

first_nameString

last_interaction_atString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

EngageATS

EngageATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

first_nameString

last_nameString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Eploy

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

companyString

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

can_emailBoolean

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring
email_address_typestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

urlsUrl[]
valuestring
url_typestring

can_emailBoolean

companyString

first_nameString

is_privateBoolean

last_interaction_atString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

Harbour ATS

Harbour ATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

first_nameString

last_nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

Homerun

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

urlsUrl[]
valuestring
url_typestring

first_nameString

last_nameString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

urlsUrl[]
valuestring
url_typestring

first_nameString

last_nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

iCIMS

iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

first_nameString

last_nameString

locationsArray

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

JobAdder

JobAdder

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

JobScore

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

urlsUrl[]
valuestring
url_typestring

companyString

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_idString

remote_updated_atString

titleString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

companyString

first_nameString

last_nameString

locationsArray

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

titleString

Lano

Lano

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

first_nameString

last_nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

urlsUrl[]
valuestring
url_typestring

companyString

first_nameString

is_privateBoolean

last_interaction_atString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

urlsUrl[]
valuestring
url_typestring

can_emailBoolean

first_nameString

is_privateBoolean

last_interaction_atString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

first_nameString

last_interaction_atString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

can_emailBoolean

companyString

first_nameString

last_interaction_atString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring
email_address_typestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

companyString

first_nameString

is_privateBoolean

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

companyString

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

companyString

first_nameString

last_interaction_atString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

can_emailBoolean

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring

urlsUrl[]
valuestring
url_typestring

first_nameString

last_nameString

locationsArray

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

remote_updated_atString

titleString

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressesEmailAddress[]
valuestring

phone_numbersPhoneNumber[]
valuestring
phone_number_typestring

companyString

first_nameString

last_nameString

locationsArray

remote_dataRemoteData[]
pathstring
dataobject

remote_idString

titleString
TalentReef

TalentReef

Coming Soon
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


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.

last_interaction_atString
Optional
When the most recent interaction with the candidate 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.

remote_template_idString
Optional

integration_paramsObject
Optional

linked_account_paramsObject
Optional

POST v1/candidates
JSON
{
"model": {
"first_name": "Gil",
"last_name": "Feig",
"company": "Columbia Dining App.",
"title": "Software Engineer",
"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"
]
},
"remote_user_id": "string"
}
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"
],
"remote_data": [
{
"path": "/candidates",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true,
"field_mappings": {
"organization_defined_targets": {
"custom_key": "custom_value"
},
"linked_account_defined_targets": {
"custom_key": "custom_value"
}
}
},
"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

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

last_nameString
Required

remote_idString
Optional

Breezy

Breezy

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

last_nameString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Additional POST Parameters


applicationsObject
Required
jobString
Required

Comeet

Comeet

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

last_nameString
Optional

locationsArray
Optional

remote_idString
Optional

Additional POST Parameters


applicationsObject
Required
jobString
Required

integration_paramsObject
Required
partner_candidate_idString
Required

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


first_nameString
Optional

last_nameString
Optional

remote_created_atString
Optional

remote_idString
Optional

remote_updated_atString
Optional

Eploy

Eploy

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


first_nameString
Optional

last_nameString
Optional

remote_idString
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


ca