Get Scorecards - Bindbee Docs

GET

api

ats

scorecards

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/scorecards \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "application": "<any>",
      "interview": "<any>",
      "interviewer": "<any>",
      "remote_created_at": "2021-01-01T00:00:00Z",
      "submitted_at": "2021-01-01T00:00:00Z",
      "overall_recommendation": "RECOMMEND"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token

string

required

Query Parameters

application

string

The application id for the scorecard

interview

string

The interview id for the scorecard

interviewer

string

The interviewer id for the scorecard

include_raw_data

boolean

default:false

Include raw data in the response

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

page_size

integer

default:50

Number of results to return per page. Maximum size is 100.

Required range: 1 <= x <= 1000

cursor

string

The pagination cursor value.

modified_after

string

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

expand

string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Response

200

application/json

Successful Response

cursor

string | null

required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size

integer

required

Indicates the count of items in the response

Example:

50

items

object[]

required

The AtsScorecard object represents an evaluation of a candidate's interview within the ATS.

items.id

string

required

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

items.remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

items.modified_at

string

required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

items.custom_fields

object | null

required

The custom fields related to the model

Example:

{
  "category_group": "REG",
  "disability_type": "ASBERG",
  "hire_date": "1991-03-16T00:00:00",
  "hire_source": "REFER",
  "nationality": "USA",
  "original_hire_date": "1991-03-16T00:00:00"
}

items.application

any | null

required

The identifier of the application associated with the scorecard.

items.interview

any | null

required

The identifier of the interview associated with the scorecard.

items.interviewer

any | null

required

The identifier of the interviewer who filled out the scorecard.

items.remote_created_at

string | null

required

The ISO date string when the scorecard was created in the remote system.

Example:

"2021-01-01T00:00:00Z"

items.submitted_at

string | null

required

The ISO date string when the scorecard was submitted by the interviewer.

Example:

"2021-01-01T00:00:00Z"

items.overall_recommendation

string | null

required

The final recommendation or decision submitted by the interviewer.

Example:

"RECOMMEND"

items.raw_data

object | null

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}

Get Scheduled Interview By Id Create Scorecard

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/scorecards \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "application": "<any>",
      "interview": "<any>",
      "interviewer": "<any>",
      "remote_created_at": "2021-01-01T00:00:00Z",
      "submitted_at": "2021-01-01T00:00:00Z",
      "overall_recommendation": "RECOMMEND"
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response