Scorecards
TheScorecard object is used to represent an interviewer's candidate recommendation based on a particular interview.The Scorecard object
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
applicationStringOptional
The application being scored.
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.
JSON
{"id": "92e8a369-fffe-430d-b93a-f7e8a16563f1","remote_id": "98796","candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef","job": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","applied_at": "2021-10-15T00:00:00Z","rejected_at": "2021-11-15T00:00:00Z","source": "Campus recruiting event","credited_to": "58166795-8d68-4b30-9bfb-bfd402479484","current_stage": "d578dfdc-7b0a-4ab6-a2b0-4b40f20eb9ea","reject_reason": "59b25f2b-da02-40f5-9656-9fa0db555784","remote_was_deleted": true,Show advanced fields}
Properties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
candidateStringOptional
The candidate applying.
jobStringOptional
The job being applied for.
applied_atStringOptional
When the application was submitted.
rejected_atStringOptional
When the application was rejected.
sourceStringOptional
The application's source.
credited_toStringOptional
The user credited for this application.
current_stageStringOptional
The application's current stage.
reject_reasonStringOptional
The application's reason for rejection.
remote_was_deletedBooleanRequired
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
interviewStringOptional
The interview being scored.
interviewerStringOptional
The interviewer doing the scoring.
remote_created_atStringOptional
When the third party's scorecard was created.
submitted_atStringOptional
When the scorecard was submitted.
overall_recommendationEnumOptional
The inteviewer's recommendation. Possible values include:
DEFINITELY_NO, NO, YES, STRONG_YES, NO_DECISION, or - in cases where there is no clear mapping - the original value passed through.remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
The Scorecard object
JSON
{"id": "3eab2f17-eeb1-450d-97f0-029d8be1e06f","remote_id": "22234","application": "2872ba14-4084-492b-be96-e5eee6fc33ef","interview": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","interviewer": "bbb519a3-246e-4b95-b6b3-dba16107ba6b","remote_created_at": "2021-10-15T00:00:00Z","submitted_at": "2021-10-15T00:00:00Z","overall_recommendation": "STRONG_YES","remote_was_deleted": true,Show advanced fields}
GET
/scorecards
Returns a list of Scorecard objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
application_idStringOptional
If provided, will only return scorecards for this application.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
interview_idStringOptional
If provided, will only return scorecards for this interview.
interviewer_idStringOptional
If provided, will only return scorecards for this interviewer.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "3eab2f17-eeb1-450d-97f0-029d8be1e06f","remote_id": "22234","application": "2872ba14-4084-492b-be96-e5eee6fc33ef","interview": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","interviewer": "bbb519a3-246e-4b95-b6b3-dba16107ba6b","remote_created_at": "2021-10-15T00:00:00Z","submitted_at": "2021-10-15T00:00:00Z","overall_recommendation": "STRONG_YES","remote_was_deleted": true,Show advanced fields}]}
Field support by platform
Breezy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewerStringoverall_recommendationEnumremote_dataRemoteData[]pathstringdataobject
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewStringinterviewerStringoverall_recommendationEnumremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsubmitted_atString
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewStringinterviewerStringoverall_recommendationEnumremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsubmitted_atString
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewerStringoverall_recommendationEnumremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
SAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewStringinterviewerStringoverall_recommendationEnumremote_dataRemoteData[]pathstringdataobjectremote_idString
SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewerStringoverall_recommendationEnumremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsubmitted_atStringHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/scorecards/{id}
Returns a Scorecard object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
Which fields should be returned in non-normalized form.
Response
JSON
{"id": "3eab2f17-eeb1-450d-97f0-029d8be1e06f","remote_id": "22234","application": "2872ba14-4084-492b-be96-e5eee6fc33ef","interview": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633","interviewer": "bbb519a3-246e-4b95-b6b3-dba16107ba6b","remote_created_at": "2021-10-15T00:00:00Z","submitted_at": "2021-10-15T00:00:00Z","overall_recommendation": "STRONG_YES","remote_was_deleted": true,Show advanced fields}
Field support by platform
Breezy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewerStringoverall_recommendationEnumremote_dataRemoteData[]pathstringdataobjectGreenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewStringinterviewerStringoverall_recommendationEnumremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsubmitted_atStringLever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewStringinterviewerStringoverall_recommendationEnumremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsubmitted_atStringRecruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewerStringoverall_recommendationEnumremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringSAP SuccessFactors
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewStringinterviewerStringoverall_recommendationEnumremote_dataRemoteData[]pathstringdataobjectremote_idStringSmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
applicationStringidstringremote_idstringcandidatestringjobstringapplied_atstringrejected_atstringsourcestringcredited_tostringcurrent_stagestringreject_reasonstringremote_was_deletedbooleanfield_mappingsobjectremote_dataarrayinterviewerStringoverall_recommendationEnumremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringsubmitted_atStringHint: Use the /linked-accounts endpoint to pull platform support information.