Get Job Posting

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,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"

include

string | null

The comma separated list of fields that will be included in the response

Example:

"questionnaires"

Response

200

application/json

The job 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.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.title

string | null

Example:

"Software Engineer"

data.locations

object[] | null

Show child attributes

data.locations.id

string | null

Unique identifier

Example:

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

data.locations.remote_id

string | null

Provider's unique identifier

Example:

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

data.locations.name

string | null

Example:

[
  { "id": "12345", "name": "New York" },
  { "id": "67890", "name": "Remote" }
]

data.internal

enum<string> | null

Available options:

true,

false

Example:

"true"

data.status

object

Show child attributes

data.status.value

enum<string> | null

The status of the job postings.

Available options:

live,

draft,

pending,

internal,

rejected,

closed,

archived,

unmapped_value

Example:

"live"

data.status.source_value

The source value of the job postings status.

Example:

"Live"

data.job_id

string | null

Example:

"job001"

data.remote_job_posting_id

string | null

Provider's unique identifier of the job posting

Example:

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

data.content

object

Show child attributes

data.content.plain

string | null

data.content.html

string | null

data.content.sections

object[] | null

Show child attributes

data.content.sections.id

string | null

Unique identifier

Example:

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

data.content.sections.remote_id

string | null

Provider's unique identifier

Example:

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

data.content.sections.type

object

Show child attributes

data.content.sections.type.value

enum<string> | null

The type of the description.

Available options:

responsibilities,

skills,

benefits,

company_overview,

description,

other

Example:

"responsibilities"

data.content.sections.type.source_value

The source value of the description type.

Example:

"key_responsibilities"

data.content.sections.label

string | null

Example:

"Key Responsibilities"

data.content.sections.content

string | null

Example:

"This is a plain description"

Example:

{
  "plain": "This is a plain text description",
  "html": "<p>This is an HTML description</p>"
}

data.compensation

object[] | null

Show child attributes

data.compensation.name

string | null

data.compensation.type

object

Show child attributes

data.compensation.type.value

enum<string> | null

The type of the compensation.

Available options:

salary,

hourly,

commission,

bonus,

equity,

other,

unmapped_value

Example:

"salary"

data.compensation.type.source_value

The source value of the compensation type.

Example:

"Salary"

data.compensation.pay_period

object

Show child attributes

data.compensation.pay_period.value

enum<string> | null

The pay period of the job postings.

Available options:

hour,

day,

week,

every_two_weeks,

month,

twice_a_month,

every_two_months,

quarter,

every_six_months,

year,

one_off,

none,

unmapped_value

Example:

"hour"

data.compensation.pay_period.source_value

The source value of the pay period.

Example:

"Hour"

data.compensation.pay_frequency

object

Show child attributes

data.compensation.pay_frequency.value

enum<string> | null

The pay frequency of the job postings.

Available options:

hourly,

weekly,

bi_weekly,

four_weekly,

semi_monthly,

monthly,

bi_monthly,

quarterly,

semi_annually,

yearly,

thirteen_monthly,

pro_rata,

unmapped_value,

half_yearly,

daily

Example:

"hourly"

data.compensation.pay_frequency.source_value

The source value of the pay frequency.

Example:

"Hourly"

data.compensation.currency

string | null

data.compensation.value

string | null

data.compensation.min_value

string | null

data.compensation.max_value

string | null

Example:

[
  {
    "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%"
  }
]

data.employment_type

object

Show child attributes

data.employment_type.value

enum<string> | null

The type of the employment.

Available options:

contractor,

intern,

permanent,

apprentice,

freelance,

terminated,

temporary,

seasonal,

volunteer,

probation,

internal,

external,

expatriate,

employer_of_record,

casual,

Programme,

unmapped_value

Example:

"permanent"

data.employment_type.source_value

The source value of the employment type.

Example:

"Permanent"

data.employment_contract_type

object

Show child attributes

data.employment_contract_type.value

enum<string> | null

The employment contract type.

Available options:

full_time,

shifts,

part_time,

unmapped_value

Example:

"full_time"

data.employment_contract_type.source_value

The source value of the employment contract type.

Example:

"FullTime"

data.external_url

string | null

Example:

"https://www.example.com/job-posting/abcd1234"

data.external_apply_url

string | null

Example:

"https://www.example.com/job-posting/abcd1234/apply"

data.questionnaires

object[] | null

Show child attributes

data.questionnaires.id

string | null

Unique identifier

Example:

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

data.questionnaires.remote_id

string | null

Provider's unique identifier

Example:

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

data.questionnaires.name

string | null

data.questionnaires.internal

data.questionnaires.questions

object[] | null

Show child attributes

data.questionnaires.questions.id

string | null

Unique identifier

Example:

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

data.questionnaires.questions.remote_id

string | null

Provider's unique identifier

Example:

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

data.questionnaires.questions.name

string | null

data.questionnaires.questions.type

object

Show child attributes

data.questionnaires.questions.type.value

enum<string> | null

The type of the questions.

Available options:

short_text,

long_text,

attachment,

multi_select,

single_select,

boolean,

number,

date,

video

Example:

"short_text"

data.questionnaires.questions.type.source_value

The source value of the questions type.

Example:

"ShortText"

data.questionnaires.questions.text

string | null

data.questionnaires.questions.required

data.questionnaires.questions.multiple_choice_answers

object[] | null

Show child attributes

data.questionnaires.questions.multiple_choice_answers.id

string | null

Unique identifier

Example:

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

data.questionnaires.questions.multiple_choice_answers.remote_id

string | null

Provider's unique identifier

Example:

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

data.questionnaires.questions.multiple_choice_answers.text

string | null

data.questionnaires.questions.parent_question

object

Show child attributes

data.questionnaires.questions.parent_question.id

string | null

Unique identifier

Example:

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

data.questionnaires.questions.parent_question.remote_id

string | null

Provider's unique identifier

Example:

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

data.questionnaires.questions.parent_question.option_ids

string[] | null

List of parent questions's option IDs

Example:

[
  "123e4567-e89b-12d3-a456-426614174000",
  "523e1234-e89b-fdd2-a456-762545121101"
]

data.questionnaires.questions.parent_question.remote_option_ids

string[] | null

Provider's list of parent questions's option IDs

Example:

[
  "123e4567-e89b-12d3-a456-426614174000",
  "523e1234-e89b-fdd2-a456-762545121101"
]

data.questionnaires.questions.parent_question.condition_type

object

Show child attributes

Example:

[
  {
    "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"
        }
      }
    ]
  }
]

data.created_at

string | null

Date of creation

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string | null

Date of last update

Example:

"2021-01-01T01:01:01.000Z"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

string | null

raw.response

object | null