ATS
- Overview
- Use Cases
Common Guides
API Reference
- Applications
- Assessments
- Orders
- Packages
- Results
- Background Checks
- Candidates
- Custom Field Definitions
- Departments
- Interview Stages
- Interviews
- Job Postings
- Jobs
- Lists
- Locations
- Offers
- Rejected Reasons
- Users
Get Assessments Requests
curl --request GET \
--url https://api.stackone.com/unified/ats/assessments/orders/{id} \
--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",
"package": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills"
},
"application": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"passthrough": {
"other_known_names": "John Doe"
}
},
"job": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"title": "Software Engineer",
"hiring_team": [
{
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
}
],
"passthrough": {
"other_known_names": "John Doe"
}
},
"candidate": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"first_name": "Romain",
"last_name": "Sestier",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"passthrough": {
"other_known_names": "John Doe"
},
"profile_url": "https://exmaple.com/candidate?id=xyz"
},
"requester": {
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
},
"results_update_url": "https://exmaple.com/integrations/results/update"
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Path Parameters
Query Parameters
Indicates that the raw request result is returned
Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
"id,remote_id,package,application,job,candidate,requester,results_update_url"
Response
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Package name
"Test 1"
Package description
"Skills test to gauge a candidate's proficiency in job-specific skills"
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The status of the application.
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
"hired"
The source value of the application status.
"Hired"
Value to pass through to the provider
{ "other_known_names": "John Doe" }
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Title of the job
"Software Engineer"
Hiring team for the job.
User ID of the hiring team member.
"123456"
Provider's unique identifier of the user
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
First name of the hiring team member.
"John"
Last name of the hiring team member.
"Doe"
Email of the hiring team member.
"john.doe@gmail.com"
Role of the hiring team member.
"Software Engineer"
Value to pass through to the provider
{ "other_known_names": "John Doe" }
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Candidate first name
"Romain"
Candidate last name
"Sestier"
Value to pass through to the provider
{ "other_known_names": "John Doe" }
Candidate profile url
"https://exmaple.com/candidate?id=xyz"
User ID of the hiring team member.
"123456"
Provider's unique identifier of the user
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
First name of the hiring team member.
"John"
Last name of the hiring team member.
"Doe"
Email of the hiring team member.
"john.doe@gmail.com"
Role of the hiring team member.
"Software Engineer"
Results update url
"https://exmaple.com/integrations/results/update"
Was this page helpful?
curl --request GET \
--url https://api.stackone.com/unified/ats/assessments/orders/{id} \
--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",
"package": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Test 1",
"description": "Skills test to gauge a candidate's proficiency in job-specific skills"
},
"application": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"passthrough": {
"other_known_names": "John Doe"
}
},
"job": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"title": "Software Engineer",
"hiring_team": [
{
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
}
],
"passthrough": {
"other_known_names": "John Doe"
}
},
"candidate": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"first_name": "Romain",
"last_name": "Sestier",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"passthrough": {
"other_known_names": "John Doe"
},
"profile_url": "https://exmaple.com/candidate?id=xyz"
},
"requester": {
"user_id": "123456",
"remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@gmail.com",
"role": "Software Engineer"
},
"results_update_url": "https://exmaple.com/integrations/results/update"
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}