Scorecards
The
Scorecard
object is used to represent an interviewer's candidate recommendation based on a particular interview.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
application
UUIDOptional
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.
Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
candidate
UUIDOptional
The candidate applying.
job
UUIDOptional
The job being applied for.
applied_at
DateTime (ISO 8601)Optional
When the application was submitted.
rejected_at
DateTime (ISO 8601)Optional
When the application was rejected.
offers
ArrayRequired
source
StringOptional
The application's source.
credited_to
UUIDOptional
The user credited for this application.
current_stage
UUIDOptional
The application's current stage.
reject_reason
UUIDOptional
The application's reason for rejection.
remote_was_deleted
BooleanRequired
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
interview
UUIDOptional
The interview being scored.
interviewer
UUIDOptional
The interviewer doing the scoring.
remote_created_at
DateTime (ISO 8601)Optional
When the third party's scorecard was created.
submitted_at
DateTime (ISO 8601)Optional
When the scorecard was submitted.
overall_recommendation
EnumOptional
The inteviewer's recommendation. Possible values include:
DEFINITELY_NO
, NO
, YES
, STRONG_YES
, NO_DECISION
. In cases where there is no clear mapping, the original value passed through will be returned.remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/scorecards
https://api.merge.dev/api/ats/v1/scorecards
US
EU
Returns a list of Scorecard
objects.
Query & Path Parameters
application_id
StringOptional
If provided, will only return scorecards for this application.
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
interview_id
StringOptional
If provided, will only return scorecards for this interview.
interviewer_id
StringOptional
If provided, will only return scorecards for this interviewer.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
remote_id
StringOptional
The API provider's ID for the given object.
show_enum_origins
StringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Breezy
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterviewer
UUIDoverall_recommendation
Enumremote_data
RemoteData[]path
stringdata
stringGreenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterview
UUIDinterviewer
UUIDoverall_recommendation
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubmitted_at
DateTime (ISO 8601)Lever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterview
UUIDinterviewer
UUIDoverall_recommendation
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubmitted_at
DateTime (ISO 8601)SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterview
UUIDinterviewer
UUIDoverall_recommendation
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
StringSmartRecruiters
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterviewer
UUIDoverall_recommendation
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubmitted_at
DateTime (ISO 8601)Tellent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterviewer
UUIDoverall_recommendation
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
StringGET
/scorecards/{id}
https://api.merge.dev/api/ats/v1/scorecards/{id}
US
EU
Returns a Scorecard
object with the given id
.
Query & Path Parameters
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fields
StringOptional
Deprecated. Use show_enum_origins.
show_enum_origins
StringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Breezy
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterviewer
UUIDoverall_recommendation
Enumremote_data
RemoteData[]path
stringdata
stringGreenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterview
UUIDinterviewer
UUIDoverall_recommendation
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubmitted_at
DateTime (ISO 8601)Lever
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterview
UUIDinterviewer
UUIDoverall_recommendation
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubmitted_at
DateTime (ISO 8601)SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterview
UUIDinterviewer
UUIDoverall_recommendation
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
StringSmartRecruiters
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterviewer
UUIDoverall_recommendation
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubmitted_at
DateTime (ISO 8601)Tellent
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
application
UUIDid
stringremote_id
stringcreated_at
stringmodified_at
stringcandidate
stringjob
stringapplied_at
stringrejected_at
stringoffers
arraysource
stringcredited_to
stringcurrent_stage
stringreject_reason
stringremote_was_deleted
booleanfield_mappings
objectremote_data
arrayinterviewer
UUIDoverall_recommendation
Enumremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
String