Get Assessments Requests

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

id

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,package,application,job,candidate,requester,results_update_url"

Response

200

application/json

The assessments order with the given identifier was retrieved.

data

object

required

Show child attributes

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.package

object

Show child attributes

data.package.id

string | null

Unique identifier

Example:

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

data.package.remote_id

string | null

Provider's unique identifier

Example:

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

data.package.name

string | null

Package name

Example:

"Test 1"

data.package.description

string | null

Package description

Example:

"Skills test to gauge a candidate's proficiency in job-specific skills"

data.application

object

Show child attributes

data.application.id

string | null

Unique identifier

Example:

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

data.application.remote_id

string | null

Provider's unique identifier

Example:

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

data.application.application_status

object

Show child attributes

data.application.application_status.value

enum<string> | null

The status of the application.

Available options:

active,

assessment,

background_check,

converted,

declined_by_candidate,

hired,

interview,

lead,

offer,

reference_check,

rejected,

review,

screen,

new,

onboarding,

created,

accepted,

short_list,

approved,

unmapped_value

Example:

"hired"

data.application.application_status.source_value

The source value of the application status.

Example:

"Hired"

data.application.passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

data.job

object

Show child attributes

data.job.id

string | null

Unique identifier

Example:

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

data.job.remote_id

string | null

Provider's unique identifier

Example:

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

data.job.title

string | null

Title of the job

Example:

"Software Engineer"

data.job.hiring_team

object[] | null

Hiring team for the job.

Show child attributes

data.job.hiring_team.user_id

string | null

User ID of the hiring team member.

Example:

"123456"

data.job.hiring_team.remote_user_id

string | null

Provider's unique identifier of the user

Example:

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

data.job.hiring_team.first_name

string | null

First name of the hiring team member.

Example:

"John"

data.job.hiring_team.last_name

string | null

Last name of the hiring team member.

Example:

"Doe"

data.job.hiring_team.email

string | null

Email of the hiring team member.

Example:

"[e-mail]"

data.job.hiring_team.role

string | null

Role of the hiring team member.

Example:

"Software Engineer"

data.job.passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

data.candidate

object

Show child attributes

data.candidate.id

string | null

Unique identifier

Example:

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

data.candidate.remote_id

string | null

Provider's unique identifier

Example:

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

data.candidate.first_name

string | null

Candidate first name

Example:

"Romain"

data.candidate.last_name

string | null

Candidate last name

Example:

"Sestier"

data.candidate.emails

object[] | null

List of candidate emails

Show child attributes

data.candidate.emails.type

string | null

Type of the email

Example:

"personal"

data.candidate.emails.value

string | null

Email value

Example:

"[e-mail]"

data.candidate.passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

data.candidate.profile_url

string | null

Candidate profile url

Example:

"https://exmaple.com/candidate?id=xyz"

data.requester

object

Show child attributes

data.requester.user_id

string | null

User ID of the hiring team member.

Example:

"123456"

data.requester.remote_user_id

string | null

Provider's unique identifier of the user

Example:

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

data.requester.first_name

string | null

First name of the hiring team member.

Example:

"John"

data.requester.last_name

string | null

Last name of the hiring team member.

Example:

"Doe"

data.requester.email

string | null

Email of the hiring team member.

Example:

"[e-mail]"

data.requester.role

string | null

Role of the hiring team member.

Example:

"Software Engineer"

data.results_update_url

string | null

Results update url

Example:

"https://exmaple.com/integrations/results/update"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

string | null

raw.response

object | null