Assessments
The
Assessment object is used to represent a per-candidate instance of an assessment template.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
assessment_templateUUIDThe catalog entry from which this instance was created.
applicationUUIDParent application being assessed.
The Application object
The Application Object is used to represent a candidate's journey through a particular Job's recruiting process. If a Candidate applies for multiple Jobs, there will be a separate Application for each Job if the third-party integration allows it.
Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
candidateUUIDThe candidate applying.
jobUUIDThe job being applied for.
applied_atDateTime (ISO 8601)When the application was submitted.
rejected_atDateTime (ISO 8601)When the application was rejected.
offersArraysourceStringThe application's source.
credited_toUUIDThe user credited for this application.
screening_question_answersScreeningQuestionAnswer[]current_stageUUIDThe application's current stage.
reject_reasonUUIDThe application's reason for rejection.
remote_was_deletedBooleanIndicates 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.
field_mappingsObjectremote_dataRemoteData[]candidateUUIDCandidate being assessed.
The Candidate object
The
Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
first_nameStringThe candidate's first name.
last_nameStringThe candidate's last name.
companyStringThe candidate's current company.
titleStringThe candidate's current title.
remote_created_atDateTime (ISO 8601)When the third party's candidate was created.
remote_updated_atDateTime (ISO 8601)When the third party's candidate was updated.
last_interaction_atDateTime (ISO 8601)When the most recent interaction with the candidate occurred.
is_privateBooleanWhether or not the candidate is private.
can_emailBooleanWhether or not the candidate can be emailed.
locationsArrayThe candidate's locations.
phone_numbersPhoneNumber[]email_addressesEmailAddress[]urlsUrl[]tagsArrayArray of
Tag names as strings.applicationsApplication[]Array of
Application object IDs.attachmentsAttachment[]Array of
Attachment object IDs.remote_was_deletedBooleanIndicates 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.
field_mappingsObjectremote_dataRemoteData[]statusEnumAssessment lifecycle status. Possible values include:
SENT, IN_PROGRESS, COMPLETED, EXPIRED, CANCELLED, FAILED. 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.sent_atDateTime (ISO 8601)When the assessment was sent to the candidate.
completed_atDateTime (ISO 8601)When the candidate completed the assessment.
scoreNumberNormalized numeric score.
result_urlStringRecruiter-facing link to full report or transcript.
assessment_urlStringCandidate-facing URL to take the assessment.
remote_was_deletedBooleanIndicates 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.
field_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.