Get Application Scorecard

GET

unified

ats

applications

{id}

scorecards

{subResourceId}

curl --request GET \
  --url https://api.stackone.com/unified/ats/applications/{id}/scorecards/{subResourceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "sections": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "label": "Technical Skills",
        "fields": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "label": "Problem Solving",
            "type": "text",
            "values": [
              "Excellent",
              "Good",
              "Average",
              "Poor"
            ],
            "required": true
          }
        ]
      }
    ],
    "label": "Technical Interview",
    "candidate_id": "5678-9",
    "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "application_id": "1011-12",
    "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "interview_id": "1314-15",
    "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "author_id": "1617-18",
    "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "overall_recommendation": "recommended",
    "created_at": "2021-01-01T00:00.000Z",
    "updated_at": "2021-01-01T00:00.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

subResourceId

string

required

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

proxy

object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at"

Response

200

application/json

The scorecard related to the application with the given identifiers was retrieved.

data

object

required

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.sections

object[] | null

The sections in the scorecard

data.sections.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.sections.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.sections.label

string | null

The label of the section

Example:

"Technical Skills"

data.sections.fields

object[] | null

The fields within the section

data.sections.fields.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.sections.fields.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.sections.fields.label

string | null

The label of the field

Example:

"Problem Solving"

data.sections.fields.type

enum<string> | null

The type of the field

Available options:

short_text,

long_text,

multi_select,

single_select,

boolean,

number,

date,

phone,

email,

score,

location,

unmapped_value

Example:

"text"

data.sections.fields.values

string[] | null

The possible values for the field

Example:

["Excellent", "Good", "Average", "Poor"]

data.sections.fields.required

Indicates if the field is required

Example:

true

data.label

string | null

The label of the scorecard

Example:

"Technical Interview"

data.candidate_id

string | null

The candidate ID associated with the scorecard

Example:

"5678-9"

data.remote_candidate_id

string | null

Provider's unique identifier of the candidate

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.application_id

string | null

The application ID associated with the scorecard

Example:

"1011-12"

data.remote_application_id

string | null

Provider's unique identifier of the application

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.interview_id

string | null

The interview ID associated with the scorecard

Example:

"1314-15"

data.remote_interview_id

string | null

Provider's unique identifier of the interview

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.author_id

string | null

The author ID of the scorecard

Example:

"1617-18"

data.remote_author_id

string | null

Provider's unique identifier of the author

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.overall_recommendation

enum<string> | null

The overall recommendation

Available options:

strong_yes,

yes,

no,

strong_no,

no_decision,

unmapped_value

Example:

"recommended"

data.created_at

string | null

The creation date of the scorecard

Example:

"2021-01-01T00:00.000Z"

data.updated_at

string | null

The update date of the scorecard

Example:

"2021-01-01T00:00.000Z"

raw

object[] | null

Was this page helpful?

Suggest edits

Create Application Get Application

curl --request GET \
  --url https://api.stackone.com/unified/ats/applications/{id}/scorecards/{subResourceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "sections": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "label": "Technical Skills",
        "fields": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "label": "Problem Solving",
            "type": "text",
            "values": [
              "Excellent",
              "Good",
              "Average",
              "Poor"
            ],
            "required": true
          }
        ]
      }
    ],
    "label": "Technical Interview",
    "candidate_id": "5678-9",
    "remote_candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "application_id": "1011-12",
    "remote_application_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "interview_id": "1314-15",
    "remote_interview_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "author_id": "1617-18",
    "remote_author_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "overall_recommendation": "recommended",
    "created_at": "2021-01-01T00:00.000Z",
    "updated_at": "2021-01-01T00:00.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

ATS

Common Guides

API Reference

Get Application Scorecard

Authorizations

Headers

Path Parameters

Query Parameters

Response