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.idUUIDremote_idStringcreated_atDateTime (ISO 8601)modified_atDateTime (ISO 8601)first_nameStringlast_nameStringcompanyStringtitleStringremote_created_atDateTime (ISO 8601)remote_updated_atDateTime (ISO 8601)last_interaction_atDateTime (ISO 8601)is_privateBooleancan_emailBooleanlocationsArrayphone_numbersPhoneNumber[]PhoneNumber object is used to represent a candidate's phone number.created_atDateTime (ISO 8601)modified_atDateTime (ISO 8601)valueStringphone_number_typeEnumHOME, WORK, MOBILE, SKYPE, OTHER. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleanemail_addressesEmailAddress[]EmailAddress object is used to represent a candidate's email address.created_atDateTime (ISO 8601)modified_atDateTime (ISO 8601)valueStringemail_address_typeEnumPERSONAL, WORK, OTHER. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleanurlsUrl[]Url object is used to represent hyperlinks associated with the parent model.created_atDateTime (ISO 8601)modified_atDateTime (ISO 8601)valueStringurl_typeEnumPERSONAL, COMPANY, PORTFOLIO, BLOG, SOCIAL_MEDIA, OTHER, JOB_POSTING. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleantagsArrayTag names as strings.applicationsApplication[]Application object IDs.idUUIDremote_idStringcreated_atDateTime (ISO 8601)modified_atDateTime (ISO 8601)candidateUUIDjobUUIDapplied_atDateTime (ISO 8601)rejected_atDateTime (ISO 8601)offersArraysourceStringcredited_toUUIDscreening_question_answersScreeningQuestionAnswer[]current_stageUUIDreject_reasonUUIDremote_was_deletedBooleanfield_mappingsObjectremote_dataRemoteData[]attachmentsAttachment[]Attachment object IDs.Attachment object is used to represent a file attached to a candidate.idUUIDremote_idStringcreated_atDateTime (ISO 8601)modified_atDateTime (ISO 8601)file_nameStringfile_urlStringcandidateUUIDattachment_typeEnumRESUME, COVER_LETTER, OFFER_LETTER, OTHER. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleanfield_mappingsObjectremote_dataRemoteData[]remote_was_deletedBooleanfield_mappingsObjectremote_dataRemoteData[]RemoteData object is used to represent the full data pulled from the third-party API for an object.pathStringdataAnyhttps://api.merge.dev/api/ats/v1/candidates
Returns a list of Candidate objects.
created_afterDateTime (ISO 8601)created_beforeDateTime (ISO 8601)cursorStringemail_addressesStringexpandStringfirst_nameStringinclude_deleted_dataBooleaninclude_remote_dataBooleaninclude_shell_dataBooleanlast_nameStringmodified_afterDateTime (ISO 8601)modified_beforeDateTime (ISO 8601)page_sizeIntegerremote_idStringtagsString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]candidatestringjobstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringcurrent_stagestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringcandidatestringattachment_typestringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
applicationsApplication[]candidatestringjobstringcurrent_stagestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringSupported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringcandidatestringattachment_typestringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcompanyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
urlsUrl[]applicationsApplication[]remote_idstringcandidatestringjobstringcurrent_stagestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringcan_emailBooleanfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]candidatestringjobstringsourcestringcurrent_stagestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringcompanyStringfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringcurrent_stagestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringoffersarraysourcestringcurrent_stagestringattachmentsAttachment[]file_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringapplied_atstringcurrent_stagestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringcurrent_stagestringcan_emailBooleancompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringoffersarraysourcestringcurrent_stagestringattachmentsAttachment[]file_namestringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringsourcestringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringtagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringattachmentsAttachment[]file_namestringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcredited_tostringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcurrent_stagestringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcan_emailBooleancompanyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringcompanyStringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]candidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcan_emailBooleanfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringcompanyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringrejected_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringapplicationsApplication[]candidatestringjobstringattachmentsAttachment[]file_namestringcandidatestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringrejected_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleStringhttps://api.merge.dev/api/ats/v1/candidates
Creates a Candidate object with the given values.
is_debug_modeBooleanrun_asyncBooleanmodelObjectremote_user_idStringfirst_nameStringlast_nameStringcompanyStringtitleStringlast_interaction_atDateTime (ISO 8601)is_privateBooleancan_emailBooleanlocationsArrayphone_numbersArrayemail_addressesArrayurlsArraytagsArrayTag names as strings.applicationsArrayApplication object IDs.attachmentsArrayAttachment object IDs.remote_template_idStringintegration_paramsObjectlinked_account_paramsObject
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayremote_idStringtagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringremote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported POST Model Parameters
can_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanSupported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
integration_paramsObjectpartner_candidate_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported POST Model Parameters
companyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported POST Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycan_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
remote_user_idString
Supported POST Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcandidate_sourceString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcurrent_stagestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcandidate_folder_idStringcandidate_folder_nameString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycan_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcredited_tostringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
remote_user_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringAdditional POST Parameters
attachmentsStringlocationsString
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
attachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcountryString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
can_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringcan_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)urlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]candidatestringjobstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_dataRemoteData[]pathstringdatastringremote_idStringhttps://api.merge.dev/api/ats/v1/candidates/{id}
Returns a Candidate object with the given id.
expandStringidUUIDinclude_remote_dataBooleaninclude_shell_dataBoolean
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]candidatestringjobstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringcurrent_stagestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringcandidatestringattachment_typestringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
applicationsApplication[]candidatestringjobstringcurrent_stagestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringSupported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringcandidatestringattachment_typestringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcompanyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
urlsUrl[]applicationsApplication[]remote_idstringcandidatestringjobstringcurrent_stagestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringcan_emailBooleanfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]candidatestringjobstringsourcestringcurrent_stagestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringcompanyStringfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringcurrent_stagestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringoffersarraysourcestringcurrent_stagestringattachmentsAttachment[]file_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringapplied_atstringcurrent_stagestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringtagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringcurrent_stagestringcan_emailBooleancompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringoffersarraysourcestringcurrent_stagestringattachmentsAttachment[]file_namestringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringsourcestringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringtagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringattachmentsAttachment[]file_namestringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcredited_tostringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcurrent_stagestringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_updated_atDateTime (ISO 8601)
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcan_emailBooleancompanyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringcompanyStringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringapplicationsApplication[]candidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringcan_emailBooleanfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringcompanyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleanfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringrejected_atstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringurlsUrl[]valuestringapplicationsApplication[]candidatestringjobstringattachmentsAttachment[]file_namestringcandidatestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringtagsArray
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringfirst_nameStringlast_nameStringlocationsArrayremote_dataRemoteData[]pathstringdatastringremote_idString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringrejected_atstringoffersarraysourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringemail_address_typestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported Response Fields
email_addressesEmailAddress[]valuestringphone_numbersPhoneNumber[]valuestringphone_number_typestringurlsUrl[]valuestringurl_typestringapplicationsApplication[]candidatestringjobstringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringfirst_nameStringlast_nameStringlocationsArrayremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)titleStringhttps://api.merge.dev/api/ats/v1/candidates/{id}
Updates a Candidate object with the given id.
idUUIDis_debug_modeBooleanrun_asyncBooleanmodelObjectremote_user_idStringfirst_nameStringlast_nameStringcompanyStringtitleStringlast_interaction_atDateTime (ISO 8601)is_privateBooleancan_emailBooleanlocationsArrayphone_numbersArrayemail_addressesArrayurlsArraytagsArrayTag names as strings.applicationsArrayApplication object IDs.attachmentsArrayAttachment object IDs.remote_template_idStringintegration_paramsObjectlinked_account_paramsObject
Supported PATCH Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported PATCH Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported PATCH Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported PATCH Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported PATCH Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringremote_updated_atDateTime (ISO 8601)https://api.merge.dev/api/ats/v1/candidates/ignore/{model_id}
Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
model_idUUIDreasonEnumGENERAL_CUSTOMER_REQUEST, GDPR, OTHER.messageString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayremote_idStringtagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringremote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported POST Model Parameters
can_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanSupported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
integration_paramsObjectpartner_candidate_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported POST Model Parameters
companyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported POST Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycan_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
remote_user_idString
Supported POST Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcandidate_sourceString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcurrent_stagestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcandidate_folder_idStringcandidate_folder_nameString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycan_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcredited_tostringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
remote_user_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringAdditional POST Parameters
attachmentsStringlocationsString
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
attachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcountryString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
can_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringcan_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)urlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]candidatestringjobstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_dataRemoteData[]pathstringdatastringremote_idStringhttps://api.merge.dev/api/ats/v1/candidates/meta/patch/{id}
Returns metadata for Candidate PATCHs.
idUUID
Supported PATCH Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported PATCH Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported PATCH Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported PATCH Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported PATCH Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringremote_updated_atDateTime (ISO 8601)https://api.merge.dev/api/ats/v1/candidates/meta/post
Returns metadata for Candidate POSTs.

Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayremote_idStringtagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringremote_created_atDateTime (ISO 8601)remote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringremote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleString
Supported POST Model Parameters
can_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanSupported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringcurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
integration_paramsObjectpartner_candidate_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported POST Model Parameters
companyStringfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleString
Supported POST Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycan_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArray
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
remote_user_idString
Supported POST Model Parameters
email_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcandidate_sourceString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcurrent_stagestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcandidate_folder_idStringcandidate_folder_nameString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycan_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcredited_tostringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarraycompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedbooleanAdditional POST Parameters
remote_user_idString
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringAdditional POST Parameters
attachmentsStringlocationsString
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringremote_created_atDateTime (ISO 8601)remote_idStringtitleString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringcurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcan_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
attachmentsAttachment[]file_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringAdditional POST Parameters
integration_paramsObjectcountryString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringcompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
can_emailBooleancompanyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringis_privateBooleanlast_interaction_atDateTime (ISO 8601)last_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]idstringremote_idstringcreated_atstringmodified_atstringfile_namestringfile_urlstringcandidatestringattachment_typestringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringlocationsArrayphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idString
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringscreening_question_answersarraycurrent_stagestringreject_reasonstringcan_emailBooleanemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArrayurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_interaction_atDateTime (ISO 8601)last_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)urlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]idstringremote_idstringcreated_atstringmodified_atstringcandidatestringjobstringapplied_atstringrejected_atstringoffersarraysourcestringcredited_tostringscreening_question_answersarraycurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_idStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
companyStringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)titleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]candidatestringjobstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)tagsArraytitleStringurlsUrl[]created_atstringmodified_atstringvaluestringurl_typestringremote_was_deletedboolean
Supported POST Model Parameters
applicationsApplication[]remote_idstringcandidatestringjobstringsourcestringscreening_question_answersarraycurrent_stagestringattachmentsAttachment[]remote_idstringfile_namestringfile_urlstringcandidatestringattachment_typestringemail_addressesEmailAddress[]created_atstringmodified_atstringvaluestringemail_address_typestringremote_was_deletedbooleanfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]created_atstringmodified_atstringvaluestringphone_number_typestringremote_was_deletedbooleanremote_dataRemoteData[]pathstringdatastringremote_idString