ATS
- Overview
- Use Cases
Common Guides
API Reference
- Applications
- Assessments
- Background Checks
- Candidates
- Custom Field Definitions
- Departments
- Interview Stages
- Interviews
- Job Postings
- Jobs
- Lists
- Locations
- Offers
- Rejected Reasons
- Users
Get Job
curl --request GET \
--url https://api.stackone.com/unified/ats/jobs/{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",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"code": "184919",
"title": "Software Engineer",
"status": "archived",
"job_status": {
"value": "published",
"source_value": "Published"
},
"department_ids": [
"308570",
"308571",
"308572"
],
"remote_department_ids": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"location_ids": [
"668570",
"678571",
"688572"
],
"remote_location_ids": [
"668570",
"678571",
"688572"
],
"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"
}
],
"interview_stages": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "<string>",
"order": 123,
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
}
],
"confidential": "true",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
],
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"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,code,title,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at"
The comma separated list of fields that will be expanded in the response
"job_postings,interview_stages"
The comma separated list of fields that will be included in the response
"custom_fields"
Response
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Custom Unified Fields configured in your StackOne project
{
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
}
Code of the job
"184919"
Title of the job
"Software Engineer"
Status of the job
"archived"
Department ids of the job
["308570", "308571", "308572"]
Provider's department ids of the job
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
Location ids of the job
["668570", "678571", "688572"]
Provider's location ids of the job
["668570", "678571", "688572"]
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"
Interview stages for the job.
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Custom Unified Fields configured in your StackOne project
{
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
}
Interview Stage created date
"2021-01-01T01:01:01.000Z"
Interview Stage updated date
"2021-01-01T01:01:01.000Z"
Confidential status of the job
true
, false
The job custom fields
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name of the custom field.
"Training Completion Status"
The value associated with the custom field.
"Completed"
The unique identifier for the value of the custom field.
"value_456"
Provider's unique identifier for the value of the custom field.
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
Date of creation
"2021-01-01T01:01:01.000Z"
Date of last update
"2021-01-01T01:01:01.000Z"
Was this page helpful?
curl --request GET \
--url https://api.stackone.com/unified/ats/jobs/{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",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"code": "184919",
"title": "Software Engineer",
"status": "archived",
"job_status": {
"value": "published",
"source_value": "Published"
},
"department_ids": [
"308570",
"308571",
"308572"
],
"remote_department_ids": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"location_ids": [
"668570",
"678571",
"688572"
],
"remote_location_ids": [
"668570",
"678571",
"688572"
],
"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"
}
],
"interview_stages": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "<string>",
"order": 123,
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
}
],
"confidential": "true",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
],
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}