Get Job Posting

GET /unified/ats/job_postings/{id}

Get Job Posting

cURL

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>'

200

{
  "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_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "content": {
      "plain": "This is a plain text description",
      "html": "<p>This is an HTML description</p>"
    },
    "compensation": [
      {
        "title": "Base Salary",
        "type": "salary",
        "pay_period": "month",
        "pay_frequency": "yearly",
        "currency": "USD",
        "value": "50000",
        "min_value_range": "45000",
        "max_value_range": "55000"
      },
      {
        "title": "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 favourite 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"
            }
          }
        ]
      }
    ],
    "start_date": "2021-01-01T00:00:00.000Z",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

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

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy · object

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,start_date,updated_at,created_at,unified_custom_fields"

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

raw · object[] | null

Show child attributes