Scorecards

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

The Scorecard object

Properties


idString
Optional

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

applicationString
Optional
The application being scored.

interviewString
Optional
The interview being scored.

interviewerString
Optional
The interviewer doing the scoring.

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_dataRemoteData[]
Optional

The Scorecard object

{
  "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_data": [
    {
      "path": "/ratings",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}

GET

/scorecards

Returns a list of Scorecard objects.


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_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

{
  "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_data": [
        {
          "path": "/ratings",
          "data": [
            "Varies by platform"
          ]
        }
      ]
    }
  ]
}
Field support by platform

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

submitted_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

interviewString

interviewerString

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

submitted_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

interviewString

interviewerString

remote_idString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

submitted_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

interviewerString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

applicationString

remote_dataRemoteData[]

remote_created_atString

interviewerString

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

applicationString

remote_dataRemoteData[]

interviewString

interviewerString

remote_idString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

applicationString

remote_dataRemoteData[]

interviewerString
POST

/scorecards

BETA

Creates a Scorecard object with the given values.


Query & Path Parameters


remote_user_idString
Optional
The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters


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

applicationString
Optional
The application being scored. Must pass in a valid Merge ID, which can be obtained from the id field in the Application table.

interviewString
Optional
The interview being scored. Must pass in a valid Merge ID, which can be obtained from the id field in the Interview table.

interviewerString
Optional
The interviewer doing the scoring. Must pass in a valid Merge ID, which can be obtained from the id field in the Interviewer table.

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. Must pass in one of the following choices: DEFINITELY_NO, NO, YES, STRONG_YES, NO_DECISION.

Response

{
  "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_data": [
    {
      "path": "/ratings",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


overall_recommendationEnum
Required

applicationString
Required

remote_created_atString
Optional

interviewerString
Optional

remote_idString
Optional
GET

/scorecards/{id}

Returns a Scorecard object with the given id.


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

{
  "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_data": [
    {
      "path": "/ratings",
      "data": [
        "Varies by platform"
      ]
    }
  ]
}
Field support by platform

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

submitted_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

interviewString

interviewerString

remote_idString

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

submitted_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

interviewString

interviewerString

remote_idString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

submitted_atString

applicationString

remote_dataRemoteData[]

remote_created_atString

interviewerString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

applicationString

remote_dataRemoteData[]

remote_created_atString

interviewerString

remote_idString

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

applicationString

remote_dataRemoteData[]

interviewString

interviewerString

remote_idString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


overall_recommendationEnum

applicationString

remote_dataRemoteData[]

interviewerString