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 Posting
curl --request GET \
--url https://api.stackone.com/unified/ats/job_postings/{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"
},
"title": "Software Engineer",
"locations": [
{
"id": "12345",
"name": "New York"
},
{
"id": "67890",
"name": "Remote"
}
],
"internal": "true",
"status": {
"value": "live",
"source_value": "Live"
},
"job_id": "job001",
"remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"content": {
"plain": "This is a plain text description",
"html": "<p>This is an HTML description</p>"
},
"compensation": [
{
"name": "Base Salary",
"type": "salary",
"pay_period": "month",
"pay_frequency": "yearly",
"currency": "USD",
"value": "50000",
"min_value": "45000",
"max_value": "55000"
},
{
"name": "Bonus",
"type": "bonus",
"pay_frequency": "quarterly",
"currency": "USD",
"value": "10%"
}
],
"employment_type": {
"value": "permanent",
"source_value": "Permanent"
},
"employment_contract_type": {
"value": "full_time",
"source_value": "FullTime"
},
"external_url": "https://www.example.com/job-posting/abcd1234",
"external_apply_url": "https://www.example.com/job-posting/abcd1234/apply",
"questionnaires": [
{
"id": "about001",
"name": "About",
"internal": "false",
"questions": [
{
"id": "question001",
"text": "What is your name?",
"type": "short_text",
"required": true,
"parent_question": null
},
{
"id": "question002",
"text": "What are your hobbies?",
"type": "long_text",
"required": false,
"parent_question": null
},
{
"id": "question003",
"text": "What is your favorite animal?",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{
"id": "1",
"text": "Dog"
},
{
"id": "2",
"text": "Cat"
},
{
"id": "3",
"text": "Bird"
},
{
"id": "4",
"text": "Other"
}
],
"parent_question": null
},
{
"id": "question004",
"text": "Do you have previous work experience??",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{
"id": "1",
"text": "Yes"
},
{
"id": "2",
"text": "No"
}
],
"parent_question": null
},
{
"id": "question005",
"text": "What was the duration of your last employment?",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{
"id": "1",
"text": "Less than 1 year"
},
{
"id": "2",
"text": "1-2 years"
},
{
"id": "2",
"text": "More than 2 year"
}
],
"parent_question": {
"id": "question004",
"option_ids": [
"1"
],
"condition_type": "equals_to"
}
}
]
},
{
"id": "experience001",
"name": "Experience",
"internal": "false",
"questions": [
{
"id": "question004",
"text": "Please upload your resume.",
"type": "attachment",
"parent_question": null,
"required": true
},
{
"id": "question005",
"text": "Select the programming languages you are proficient in.",
"type": "multi_select",
"multiple_choice_answers": [
{
"id": "1",
"text": "JavaScript"
},
{
"id": "2",
"text": "Python"
},
{
"id": "3",
"text": "Java"
}
],
"parent_question": null,
"required": true
},
{
"id": "question006",
"text": "Are you willing to relocate?",
"type": "boolean",
"parent_question": null
},
{
"id": "question007",
"text": "How many years of experience do you have?",
"type": "number",
"parent_question": null
},
{
"id": "question008",
"text": "When did you start your most recent position?",
"type": "date",
"parent_question": null
},
{
"id": "question009",
"text": "Do you have Project Management Experience?",
"type": "single_select",
"multiple_choice_answers": [
{
"id": "1",
"text": "Yes"
},
{
"id": "2",
"text": "No"
}
],
"parent_question": null,
"required": true
},
{
"id": "question010",
"text": "How much Project Management experience do you have?",
"type": "single_select",
"multiple_choice_answers": [
{
"id": "1",
"text": "1-3 years"
},
{
"id": "2",
"text": "3-5 years"
},
{
"id": "3",
"text": "5-10 years"
},
{
"id": "4",
"text": "More than 10 years"
}
],
"parent_question": {
"id": "question009",
"option_ids": [
"1"
],
"condition_type": "equals_to"
}
}
]
}
],
"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,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,updated_at,created_at"
The comma separated list of fields that will be included in the response
"questionnaires"
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"
}
"Software Engineer"
[
{ "id": "12345", "name": "New York" },
{ "id": "67890", "name": "Remote" }
]
true
, false
"true"
"job001"
Provider's unique identifier of the job posting
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The type of the description.
responsibilities
, skills
, benefits
, company_overview
, description
, other
"responsibilities"
The source value of the description type.
"key_responsibilities"
"Key Responsibilities"
"This is a plain description"
{
"plain": "This is a plain text description",
"html": "<p>This is an HTML description</p>"
}
The pay period of the job postings.
hour
, day
, week
, every_two_weeks
, month
, twice_a_month
, every_two_months
, quarter
, every_six_months
, year
, one_off
, none
, unmapped_value
"hour"
The source value of the pay period.
"Hour"
The pay frequency of the job postings.
hourly
, weekly
, bi_weekly
, four_weekly
, semi_monthly
, monthly
, bi_monthly
, quarterly
, semi_annually
, yearly
, thirteen_monthly
, pro_rata
, unmapped_value
, half_yearly
, daily
"hourly"
The source value of the pay frequency.
"Hourly"
[
{
"name": "Base Salary",
"type": "salary",
"pay_period": "month",
"pay_frequency": "yearly",
"currency": "USD",
"value": "50000",
"min_value": "45000",
"max_value": "55000"
},
{
"name": "Bonus",
"type": "bonus",
"pay_frequency": "quarterly",
"currency": "USD",
"value": "10%"
}
]
The type of the employment.
contractor
, intern
, permanent
, apprentice
, freelance
, terminated
, temporary
, seasonal
, volunteer
, probation
, internal
, external
, expatriate
, employer_of_record
, casual
, Programme
, unmapped_value
"permanent"
The source value of the employment type.
"Permanent"
"https://www.example.com/job-posting/abcd1234"
"https://www.example.com/job-posting/abcd1234/apply"
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"
The type of the questions.
short_text
, long_text
, attachment
, multi_select
, single_select
, boolean
, number
, date
, video
"short_text"
The source value of the questions type.
"ShortText"
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"
List of parent questions's option IDs
[
"123e4567-e89b-12d3-a456-426614174000",
"523e1234-e89b-fdd2-a456-762545121101"
]
Provider's list of parent questions's option IDs
[
"123e4567-e89b-12d3-a456-426614174000",
"523e1234-e89b-fdd2-a456-762545121101"
]
[
{
"id": "about001",
"name": "About",
"internal": "false",
"questions": [
{
"id": "question001",
"text": "What is your name?",
"type": "short_text",
"required": true,
"parent_question": null
},
{
"id": "question002",
"text": "What are your hobbies?",
"type": "long_text",
"required": false,
"parent_question": null
},
{
"id": "question003",
"text": "What is your favorite animal?",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{ "id": "1", "text": "Dog" },
{ "id": "2", "text": "Cat" },
{ "id": "3", "text": "Bird" },
{ "id": "4", "text": "Other" }
],
"parent_question": null
},
{
"id": "question004",
"text": "Do you have previous work experience??",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{ "id": "1", "text": "Yes" },
{ "id": "2", "text": "No" }
],
"parent_question": null
},
{
"id": "question005",
"text": "What was the duration of your last employment?",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{ "id": "1", "text": "Less than 1 year" },
{ "id": "2", "text": "1-2 years" },
{ "id": "2", "text": "More than 2 year" }
],
"parent_question": {
"id": "question004",
"option_ids": ["1"],
"condition_type": "equals_to"
}
}
]
},
{
"id": "experience001",
"name": "Experience",
"internal": "false",
"questions": [
{
"id": "question004",
"text": "Please upload your resume.",
"type": "attachment",
"parent_question": null,
"required": true
},
{
"id": "question005",
"text": "Select the programming languages you are proficient in.",
"type": "multi_select",
"multiple_choice_answers": [
{ "id": "1", "text": "JavaScript" },
{ "id": "2", "text": "Python" },
{ "id": "3", "text": "Java" }
],
"parent_question": null,
"required": true
},
{
"id": "question006",
"text": "Are you willing to relocate?",
"type": "boolean",
"parent_question": null
},
{
"id": "question007",
"text": "How many years of experience do you have?",
"type": "number",
"parent_question": null
},
{
"id": "question008",
"text": "When did you start your most recent position?",
"type": "date",
"parent_question": null
},
{
"id": "question009",
"text": "Do you have Project Management Experience?",
"type": "single_select",
"multiple_choice_answers": [
{ "id": "1", "text": "Yes" },
{ "id": "2", "text": "No" }
],
"parent_question": null,
"required": true
},
{
"id": "question010",
"text": "How much Project Management experience do you have?",
"type": "single_select",
"multiple_choice_answers": [
{ "id": "1", "text": "1-3 years" },
{ "id": "2", "text": "3-5 years" },
{ "id": "3", "text": "5-10 years" },
{ "id": "4", "text": "More than 10 years" }
],
"parent_question": {
"id": "question009",
"option_ids": ["1"],
"condition_type": "equals_to"
}
}
]
}
]
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/job_postings/{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"
},
"title": "Software Engineer",
"locations": [
{
"id": "12345",
"name": "New York"
},
{
"id": "67890",
"name": "Remote"
}
],
"internal": "true",
"status": {
"value": "live",
"source_value": "Live"
},
"job_id": "job001",
"remote_job_posting_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"content": {
"plain": "This is a plain text description",
"html": "<p>This is an HTML description</p>"
},
"compensation": [
{
"name": "Base Salary",
"type": "salary",
"pay_period": "month",
"pay_frequency": "yearly",
"currency": "USD",
"value": "50000",
"min_value": "45000",
"max_value": "55000"
},
{
"name": "Bonus",
"type": "bonus",
"pay_frequency": "quarterly",
"currency": "USD",
"value": "10%"
}
],
"employment_type": {
"value": "permanent",
"source_value": "Permanent"
},
"employment_contract_type": {
"value": "full_time",
"source_value": "FullTime"
},
"external_url": "https://www.example.com/job-posting/abcd1234",
"external_apply_url": "https://www.example.com/job-posting/abcd1234/apply",
"questionnaires": [
{
"id": "about001",
"name": "About",
"internal": "false",
"questions": [
{
"id": "question001",
"text": "What is your name?",
"type": "short_text",
"required": true,
"parent_question": null
},
{
"id": "question002",
"text": "What are your hobbies?",
"type": "long_text",
"required": false,
"parent_question": null
},
{
"id": "question003",
"text": "What is your favorite animal?",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{
"id": "1",
"text": "Dog"
},
{
"id": "2",
"text": "Cat"
},
{
"id": "3",
"text": "Bird"
},
{
"id": "4",
"text": "Other"
}
],
"parent_question": null
},
{
"id": "question004",
"text": "Do you have previous work experience??",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{
"id": "1",
"text": "Yes"
},
{
"id": "2",
"text": "No"
}
],
"parent_question": null
},
{
"id": "question005",
"text": "What was the duration of your last employment?",
"type": "single_select",
"required": true,
"multiple_choice_answers": [
{
"id": "1",
"text": "Less than 1 year"
},
{
"id": "2",
"text": "1-2 years"
},
{
"id": "2",
"text": "More than 2 year"
}
],
"parent_question": {
"id": "question004",
"option_ids": [
"1"
],
"condition_type": "equals_to"
}
}
]
},
{
"id": "experience001",
"name": "Experience",
"internal": "false",
"questions": [
{
"id": "question004",
"text": "Please upload your resume.",
"type": "attachment",
"parent_question": null,
"required": true
},
{
"id": "question005",
"text": "Select the programming languages you are proficient in.",
"type": "multi_select",
"multiple_choice_answers": [
{
"id": "1",
"text": "JavaScript"
},
{
"id": "2",
"text": "Python"
},
{
"id": "3",
"text": "Java"
}
],
"parent_question": null,
"required": true
},
{
"id": "question006",
"text": "Are you willing to relocate?",
"type": "boolean",
"parent_question": null
},
{
"id": "question007",
"text": "How many years of experience do you have?",
"type": "number",
"parent_question": null
},
{
"id": "question008",
"text": "When did you start your most recent position?",
"type": "date",
"parent_question": null
},
{
"id": "question009",
"text": "Do you have Project Management Experience?",
"type": "single_select",
"multiple_choice_answers": [
{
"id": "1",
"text": "Yes"
},
{
"id": "2",
"text": "No"
}
],
"parent_question": null,
"required": true
},
{
"id": "question010",
"text": "How much Project Management experience do you have?",
"type": "single_select",
"multiple_choice_answers": [
{
"id": "1",
"text": "1-3 years"
},
{
"id": "2",
"text": "3-5 years"
},
{
"id": "3",
"text": "5-10 years"
},
{
"id": "4",
"text": "More than 10 years"
}
],
"parent_question": {
"id": "question009",
"option_ids": [
"1"
],
"condition_type": "equals_to"
}
}
]
}
],
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-01T01:01:01.000Z"
},
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}