Common ModelsCandidates

/candidates/{id}

Returns a Candidate object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_remote_databooleanOptional

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

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstring or nullRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only
The datetime that this object was created by Merge.
modified_atdatetime or nullRead-only
The datetime that this object was modified by Merge.
first_namestring or null
The candidate's first name.
last_namestring or null
The candidate's last name.
companystring or null
The candidate's current company.
titlestring or null
The candidate's current title.
remote_created_atdatetime or null
When the third party's candidate was created.
remote_updated_atdatetime or null
When the third party's candidate was updated.
last_interaction_atdatetime or null
When the most recent interaction with the candidate occurred.
is_privateboolean or null
Whether or not the candidate is private.
can_emailboolean or null
Whether or not the candidate can be emailed.
locationslist of strings or null
The candidate's locations.
phone_numberslist of objects or null
email_addresseslist of objects or null
urlslist of objects or null
tagslist of strings or null

Array of Tag names as strings.

applicationslist of strings or null

Array of Application object IDs.

attachmentslist of strings or null

Array of Attachment object IDs.

remote_was_deletedboolean or null
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1dbVPiyBb+K1Q+Wgij6MyOVbdu8abCCDqIus7UVKrpHKCh0x07HRC29r/fCkmA7KAXQgcS3G+kTZ4kfZ6c927/0jCS0ONiol1oSNpaVjO5AVS70MqIGcRAErSshizSRCZ45+ijUy2r2Y5lcSHBuCRADftaQFe70PImiB4cO4x0CRh5JO08YRJ6AknCmZ2fX3XcnV2mZTVK2BCMIsbcYfIdHO+8Y+Sd+I9D98+21LKahWxb9gV3ev0WvDhgvwfpPg0FE5hE9NhAEuWXLj8W3vWrxtznNoCCBKOCJKqABOy+oH+rvpSWfZHP94FaudltcwaM8sDySEiCKdj588LX0y9fz499lNnd/6v36H9OjgYvHd75cqT3MNWRc9Ro49dmuzZuDnpnzfLZa3P6cN6cDqfNwfDTkd5DR4124/y2/Vy4rRRPblecoN9//vPrY6lSqjeP8LRaaA6ex802Pmm08bAzrRXqV3hcv/7+2pw+nzYqD4Vmu3pev+Int+WW3Si3eKOYy2lZbVmO2sXPv5YHfHIULYsSjJi8lwgPw9fUTNSDpbnxpIEscmw5HUpwzi7kkImmnKGxncPczJtgEJQPY+r3Lw4SoN/wHtfHpevnx9ZNbmD1AnkQzubC0C60avO62CxXK2FiFEeIUNShoF1I4cBvXNYufmpVExFaNAwBtp3DS59C6A8jRB138K7PGTQdswMidPLyeHAu8l7Im8eshqREuO9y0D0CF11HHjy4I10ibKkzd4KzGkVLv/kCxHLvo7PZjdxjASaXoGMBSIKhI7kYc4kWPtItJPuLIWJov9yDF4cIMO6QQCZIF/bi56+/syvFbvc7E0XSdqFCQi4435/QaJyz2FtCbhbbtcdqXCIOSUSXE2srEiwLKgBbRZIHQUMY7vGAdxa/dIvbkrCe7Q85ggZ47uFaZMPctBCbbEa7N6i2Dq2ymkSzB5ZEUhfLEdTemGwjJB0Bauh2R5HscmH6oO+QLImaJEyK9RgQSeYxqpr5b8cyFgAeQTZkRgmZHc6vW2qoEaAtK6OUWZr3lUgUjaGWM+vxI4qSKAmAqSKT5GEdGA1iFv5ulIRnTCLxw6G0zwVTZEUEt0DIiX5SW4Dp89HTK2AgCF6MFHwyzQfOggdKiQVa141R736kxBT54sy0AAuHSPeVM2XKHUMN4zo+vi4W+Dp28XXbo9Z9qWLVhqOU8EmZ/nHnVqDZK3rii1UrReJGudi+V8MCFykUK9XPmsMXXt2jfXIYeXHc2QEm3TyLiFPLrLpZnAYwJQpr+xirTNFElR8dhFgeZqCePl2P2XnlJhb19A8ZvimZ+BIiZcrxcMyFohTYHO7AnNC3QlTE9NkH9gE+NG4CSDUs8V0NvYY5028ZnaTM9n/caLXMBQNhS84g00YUmLwhTJXuWGAnRHvsJ6Ear2e5H92zKc0EUG8CVZp1D9S363tUOf+fVon0TRU6nAlk6JJ1/G0+NmSvkXskDBO17K2MXEz98y16xr1uLOxdUa95MyW/lnmKP0KtoEmXC6xYUwSocc7yhvWxDeeliuzJzMdSOzEubNmFTZnDFtFP39i9UqZCqqyHeqAs/TKH27/xe8OabCCV3XYMVC3KFZVnZlDJkUCMPmtK0k9RLM4lRRL3hVq96oPqQ7Nc7tdeUkKOufCxJCMiCazwGPZXidtUrm5vHiKK6mwBWiiQTZdUV6aiV4QKkVPUyzYZOE5OT5nyGu4VmGr1xRWY+uvoEX87OU90HLurfjPFDUXE1i1BRh7+Hop1bxuriPwTAKzPHVtRnLTAWzNR91H6HrfVg0sMXU8jbsjUvadWtiJvps47mRJHwsgU72oxUxlSGvlfI9Hhjsgoix0Dm+MDB2VR4/mq/PSjkQCnZutIMiq9N5UMN0E4ihzMvgeWgOnfafFrtzHBdUtlJ9R1S5+hJaS4tSs/f3ffYzT7Qsq1hmJVWXMhDzPRE8vqjt1XvzfkSI11CSMSMiWBbLtFZiJVQJgANzCqnH9+wPXCQXNmPYLsoyFiawtfR9OpqmY0DyvUM/n0HTcqDSMBNmPXzTJJyw9tkQuq807RMEBxAnnAO8hFPUyj807X3QFXGuq8UyEjpJYoPuhhEySJC5VVmBfeucdc1YLSAO147yojOfm7dJczt8+11XnH5kRRvOuDhVyYm9MHbLDvsbgwazgWm0/HiKhqQ/TBUlgRjNPPf7OLMBaPL8ZOtDpXVTtemGrCgsBwYpxUkfMtJYRJVNAf+OrbtmTdIMbVCNhFSpgaiCdJt+kMw0hVXDSDClke/tz7Y1J62luRMhlbr2yY132nsSdi+3dKCpZRnKcGYkgiqtYI+KAJUBHRO8ISvDXDhiK+xdixuKVGxD7YocVfO0no7pMDjE66ijqCg698hklS8pHvYUeNpLRfbUoVgTCFzKVjE84yx8EWG4T1VNaVvbvoC/D9J4HX1ygJaQxQoRc8YburYhXFCTOohHULJL2DLuXuZxS/844wixOmaqmXj7Z/JZKKlfm/Eypm6oTpsiKei0Ih33aA6FI+VrrHA4hLysehSPyTNR1cXp6mRJntqN039Yumo7OOjBRl2ANveoGbLiUWg93cw765WxDiHvUgo6qBxgXTlzpoCp3x2Zck9CvvJoje72q6++Jd5t7BGGz7EmHJZ4+gQqghzJBZKeE/ee/y07/bxWxVUNu5P7OegdmUfiYScu6BqOJeGDREvsEfo5tu9Sll2iW5W7en0Z1xw3WYqnVlPMwDoFXMcX2s+cCoZGDyZtJVvAPLAnePpFC6PdUmW6PG+y8EEhxgRWJfC6CrLhPp4cXet6C+i6sNyJSIUK6ot2CBl8Lc7G5Nf7q2R42k54G6n0ZQ2gFFqQzpwQabpkPKMhm7XRuagOpghD0u2wJ1u6o3aPNB9UHbqJ//iGfTasU+QuSmpb2uPo0mcdIBCykq+y5E7qGmRDWo6W1Tvohw5zspP3y7ytwJvtQToIYWD9+ugqbh09KL8Xp7aG0l6xFBfediEjyUSMHAE1DMTchInpF9yNQd1qOKKy7+LXTJddkH3btFKvpPlGZi07Wo/YmL4Wy2lVAhQAulRW9HlDbp139jozStSlSSDHXpYCDFbZI+6IdTLLEH5x+0TPSD9+cOmFqmushB8J6u0D0h298lWTuupxZ//f0//kIyrrJ+AAA=" />