/scorecards/{id}

GET

/ats/v1/scorecards/:id

GET

/api/ats/v1/scorecards/:id

$ curl -G https://api.merge.dev/api/ats/v1/scorecards/id \
>      -H "X-Account-Token: X-Account-Token" \
>      -H "Authorization: Bearer <token>" \
>      -d expand=application \
>      -d remote_fields=overall_recommendation \
>      -d show_enum_origins=overall_recommendation

200Retrieved

1 {
2   "id": "3eab2f17-eeb1-450d-97f0-029d8be1e06f",
3   "remote_id": "22234",
4   "created_at": "2021-09-15T00:00:00Z",
5   "modified_at": "2021-10-16T00:00:00Z",
6   "application": "2872ba14-4084-492b-be96-e5eee6fc33ef",
7   "interview": "52bf9b5e-0beb-4f6f-8a72-cd4dca7ca633",
8   "interviewer": "bbb519a3-246e-4b95-b6b3-dba16107ba6b",
9   "remote_created_at": "2021-10-15T00:00:00Z",
10   "submitted_at": "2021-10-15T00:00:00Z",
11   "overall_recommendation": "STRONG_YES",
12   "remote_was_deleted": true,
13   "field_mappings": {
14     "organization_defined_targets": {
15       "custom_key": "custom_value"
16     },
17     "linked_account_defined_targets": {
18       "custom_key": "custom_value"
19     }
20   },
21   "remote_data": [
22     {
23       "path": "/ratings",
24       "data": null
25     }
26   ]
27 }

Returns a Scorecard object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

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

Allowed values:

include_remote_databooleanOptional

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

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:

show_enum_originsenumOptional

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

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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Allowed values:

Response

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

applicationstring or nullOptionalformat: "uuid"

The application being scored.

interviewstring or nullOptionalformat: "uuid"

The interview being scored.

interviewerstring or nullOptionalformat: "uuid"

The interviewer doing the scoring.

remote_created_atdatetime or nullOptional

When the third party's scorecard was created.

submitted_atdatetime or nullOptional

When the scorecard was submitted.

overall_recommendationenum or nullOptional

The inteviewer's recommendation.

remote_was_deletedbooleanOptionalRead-only

Indicates 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_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

/scorecards/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration