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
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[]PhoneNumber
object is used to represent a candidate's phone number.{"value": "+3198675309","phone_number_type": "HOME","modified_at": "2021-10-16T00:00:00Z"}
value
Stringphone_number_type
EnumHOME
, WORK
, MOBILE
, SKYPE
, OTHER
, or -
in cases where there is no clear mapping - the original value passed through.modified_at
Stringemail_addresses
EmailAddress[]EmailAddress
object is used to represent a candidate's email address.{"value": "[email protected]","email_address_type": "PERSONAL","modified_at": "2021-10-16T00:00:00Z"}
value
Stringemail_address_type
EnumPERSONAL
, WORK
, OTHER
, or -
in cases where there is no clear mapping - the original value passed through.modified_at
Stringurls
Url[]Url
object is used to represent hyperlinks associated with the parent model.{"value": "http://alturl.com/p749b","url_type": "PERSONAL","modified_at": "2021-10-16T00:00:00Z"}
value
Stringurl_type
EnumPERSONAL
, COMPANY
, PORTFOLIO
, BLOG
, SOCIAL_MEDIA
, OTHER
, JOB_POSTING
, or -
in cases where there is no clear mapping - the original value passed through.modified_at
Stringtags
ArrayTag
names as strings.applications
Application[]Application
object IDs.{"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_was_deleted": true,Show advanced fields}
id
Stringremote_id
Stringcandidate
Stringjob
Stringapplied_at
Stringrejected_at
Stringsource
Stringcredited_to
Stringcurrent_stage
Stringreject_reason
Stringremote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_data
RemoteData[]attachments
Attachment[]Attachment
object IDs.Attachment
object is used to represent a file attached to a candidate.{"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_was_deleted": true,Show advanced fields}
id
Stringremote_id
Stringfile_name
Stringfile_url
Stringcandidate
Stringattachment_type
EnumRESUME
, COVER_LETTER
, OFFER_LETTER
, OTHER
, or -
in cases where there is no clear mapping - the original value passed through.remote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_data
RemoteData[]remote_was_deleted
Booleanfield_mappings
Objectmodified_at
Stringremote_data
RemoteData[]{"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_was_deleted": true,Show advanced fields}
Returns a list of Candidate
objects.
Authorization
StringX-Account-Token
Stringcreated_after
Stringcreated_before
Stringcursor
Stringemail_addresses
Stringexpand
Stringfirst_name
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanlast_name
Stringmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
Stringtags
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"],"remote_was_deleted": true,Show advanced fields}]}

Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addresses
EmailAddress[]value
stringemail_address_type
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringurls
Url[]value
stringurl_type
stringcompany
Stringfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtitle
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applications
Application[]id
stringremote_id
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringsource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arraycompany
Stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtags
Arraytitle
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arraycan_email
Booleanfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtitle
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_interaction_at
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringcompany
Stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtitle
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arraycan_email
Booleanfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
String
Merge supports Passthrough Requests to this platform's API
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
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
Stringtitle
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addresses
EmailAddress[]value
stringurls
Url[]value
stringurl_type
stringfirst_name
Stringlast_name
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
objectremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringtags
Array
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
email_addresses
EmailAddress[]value
stringphone_numbers
PhoneNumber[]value
stringphone_number_type
stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
Stringremote_updated_at
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleanfield_mappings
objectmodified_at
stringremote_data
arraycompany
Stringfirst_name
Stringlast_name
Stringlocations
Arrayremote_created_at
Stringremote_id
Stringremote_updated_at
Stringtitle
String
Merge supports Passthrough Requests to this platform's API
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
booleanfield_mappings
objectmodified_at
stringremote_data
arrayattachments
Attachment[]id
stringremote_id
stringfile_name
stringfile_url
stringcandidate
stringattachment_type
stringremote_was_deleted
booleanfield_mappings
objectmodified_at
stringremote_data