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.id
UUIDremote_id
Stringfirst_name
Stringlast_name
Stringcompany
Stringtitle
Stringremote_created_at
DateTime (ISO 8601)remote_updated_at
DateTime (ISO 8601)last_interaction_at
DateTime (ISO 8601)is_private
Booleancan_email
Booleanlocations
Arrayphone_numbers
PhoneNumber[]PhoneNumber
object is used to represent a candidate's phone number.value
Stringphone_number_type
EnumHOME
, WORK
, MOBILE
, SKYPE
, OTHER
. In cases where there is no clear mapping, the original value passed through will be returned.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)email_addresses
EmailAddress[]EmailAddress
object is used to represent a candidate's email address.value
Stringemail_address_type
EnumPERSONAL
, WORK
, OTHER
. In cases where there is no clear mapping, the original value passed through will be returned.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)urls
Url[]Url
object is used to represent hyperlinks associated with the parent model.value
Stringurl_type
EnumPERSONAL
, COMPANY
, PORTFOLIO
, BLOG
, SOCIAL_MEDIA
, OTHER
, JOB_POSTING
. In cases where there is no clear mapping, the original value passed through will be returned.created_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)tags
ArrayTag
names as strings.applications
Application[]Application
object IDs.id
UUIDremote_id
Stringcandidate
UUIDjob
UUIDapplied_at
DateTime (ISO 8601)rejected_at
DateTime (ISO 8601)source
Stringcredited_to
UUIDcurrent_stage
UUIDreject_reason
UUIDremote_was_deleted
Booleancreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)field_mappings
Objectremote_data
RemoteData[]attachments
Attachment[]Attachment
object IDs.Attachment
object is used to represent a file attached to a candidate.id
UUIDremote_id
Stringfile_name
Stringfile_url
Stringcandidate
UUIDattachment_type
EnumRESUME
, COVER_LETTER
, OFFER_LETTER
, OTHER
. In cases where there is no clear mapping, the original value passed through will be returned.remote_was_deleted
Booleancreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)field_mappings
Objectremote_data
RemoteData[]remote_was_deleted
Booleancreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)field_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/ats/v1/candidates
Returns a list of Candidate
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringemail_addresses
Stringexpand
Stringfirst_name
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanlast_name
Stringmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_id
Stringtags
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringemail_address_type
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycompany
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtags
Arraytitle
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tags
Array
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycompany
Stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringurls
Url[]value
stringurl_type
stringattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycompany
Stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tags
Arraytitle
String
Supported Response Fields
applications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringurls
Url[]value
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycan_email
Booleanfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tags
Arraytitle
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringemail_address_type
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_interaction_at
DateTime (ISO 8601)last_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tags
Array
Supported Response Fields
email_addresses
EmailAddress[]value
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycompany
Stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)title
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycan_email
Booleanfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tags
Array
Supported Response Fields
email_addresses
EmailAddress[]value
stringemail_address_type
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringurls
Url[]value
stringurl_type
stringcan_email
Booleancompany
Stringfirst_name
Stringis_private
Booleanlast_interaction_at
DateTime (ISO 8601)last_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tags
Arraytitle
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)
Supported Response Fields
email_addresses
EmailAddress[]value
stringurls
Url[]value
stringurl_type
stringfirst_name
Stringlast_name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringtags
Array
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycompany
Stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)tags
Arraytitle
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycompany
Stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtitle
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arraycompany
Stringfirst_name
Stringis_private
Booleanlast_interaction_at
DateTime (ISO 8601)last_name
Stringlocations
Arrayremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)tags
Array
Supported Response Fields
phone_numbers
PhoneNumber[]value
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleancreated_at
stringmodified_at
stringfield_mappings
objectremote_data
arrayfirst_name
Stringlast_name
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringurls
Url[]value
stringurl_type
stringapplications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to