Scorecards

The Scorecard object is used to represent a Scorecard for an interview

The Scorecard object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

applicationString
Optional

interviewString
Optional

interviewerString
Optional

remote_created_atString
Optional
When the third party's scorecard was created.

submitted_atString
Optional
When the scorecard was submitted.

overall_recommendationEnum
Optional
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_deletedBoolean
Required
Indicates whether or not this object has been deleted on the third-party.

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
}

GET

/scorecards

Returns a list of Scorecard objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


application_idString
Optional
If provided, will only return scorecards for this application.

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was deleted in the third-party service.

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

interview_idString
Optional
If provided, will only return scorecards for this interview.

interviewer_idString
Optional
If provided, will only return scorecards for this interviewer.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

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
}
]
}
Field support by platform

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

interviewerString

applicationString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

submitted_atString

overall_recommendationEnum

remote_created_atString

remote_idString

interviewerString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


submitted_atString

overall_recommendationEnum

remote_created_atString

remote_idString

interviewString

interviewerString

applicationString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

remote_created_atString

remote_idString

interviewerString

applicationString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

remote_idString

interviewString

interviewerString

applicationString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


submitted_atString

overall_recommendationEnum

remote_created_atString

remote_idString

interviewString

interviewerString

applicationString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/scorecards/{id}

Returns a Scorecard object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
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
}
Field support by platform

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

interviewerString

applicationString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


applicationString

submitted_atString

overall_recommendationEnum

remote_created_atString

remote_idString

interviewerString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


submitted_atString

overall_recommendationEnum

remote_created_atString

remote_idString

interviewString

interviewerString

applicationString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

remote_created_atString

remote_idString

interviewerString

applicationString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

remote_idString

interviewString

interviewerString

applicationString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


submitted_atString

overall_recommendationEnum

remote_created_atString

remote_idString

interviewString

interviewerString

applicationString
Hint: Use the /linked-accounts endpoint to pull platform support information.