Get Job

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",
    "description": "Responsible for identifying business requirements",
    "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": "[email protected]",
        "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": {},
      "response": {}
    }
  ]
}

GET

unified

ats

jobs

{id}

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",
    "description": "Responsible for identifying business requirements",
    "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": "[email protected]",
        "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": {},
      "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

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,code,title,description,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at,unified_custom_fields"

expand

string | null

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

Example:

"job_postings,interview_stages"

include

string | null

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

Example:

"custom_fields"

Response

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

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.code

string | null

Code of the job

Example:

"184919"

data.title

string | null

Title of the job

Example:

"Software Engineer"

data.description

string | null

Description of the job

Example:

"Responsible for identifying business requirements"

data.status

string | null

deprecated

Status of the job

Example:

"archived"

data.job_status

object

Status of the job

Show child attributes

data.job_status.value

enum<string> | null

The status of the job.

Available options:

published,

draft,

pending,

internal,

archived,

closed,

open,

deleted,

on_hold,

unmapped_value,

Example:

"published"

data.job_status.source_value

The source value of the job status.

Example:

"Published"

data.department_ids

string[] | null

Department ids of the job

Example:

["308570", "308571", "308572"]

data.remote_department_ids

string[] | null

Provider's department ids of the job

Example:

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

data.location_ids

string[] | null

Location ids of the job

Example:

["668570", "678571", "688572"]

data.remote_location_ids

string[] | null

Provider's location ids of the job

Example:

["668570", "678571", "688572"]

data.hiring_team

object[] | null

Hiring team for the job.

Show child attributes

data.hiring_team.user_id

string | null

User ID of the hiring team member.

Example:

"123456"

data.hiring_team.remote_user_id

string | null

Provider's unique identifier of the user

Example:

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

data.hiring_team.first_name

string | null

First name of the hiring team member.

Example:

"John"

data.hiring_team.last_name

string | null

Last name of the hiring team member.

Example:

"Doe"

data.hiring_team.email

string | null

Email of the hiring team member.

Example:

"[email protected]"

data.hiring_team.role

string | null

Role of the hiring team member.

Example:

"Software Engineer"

data.interview_stages

object[] | null

Interview stages for the job.

Show child attributes

data.interview_stages.id

string | null

Unique identifier

Example:

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

data.interview_stages.remote_id

string | null

Provider's unique identifier

Example:

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

data.interview_stages.unified_custom_fields

object

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.interview_stages.name

string | null

data.interview_stages.order

number | null

data.interview_stages.created_at

string<date-time> | null

Interview Stage created date

Example:

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

data.interview_stages.updated_at

string<date-time> | null

Interview Stage updated date

Example:

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

data.confidential

enum<string> | null

Confidential status of the job

Available options:

true,

false,

unmapped_value,

data.custom_fields

object[] | null

The job custom fields

Show child attributes

data.custom_fields.id

string | null

Unique identifier

Example:

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

data.custom_fields.remote_id

string | null

Provider's unique identifier

Example:

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

data.custom_fields.name

string | null

The name of the custom field.

Example:

"Training Completion Status"

data.custom_fields.value

The value associated with the custom field.

Example:

"Completed"

data.custom_fields.value_id

string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

data.custom_fields.remote_value_id

string | null

Provider's unique identifier for the value of the custom field.

Example:

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

data.created_at

string<date-time> | null

Date of creation

Example:

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

data.updated_at

string<date-time> | 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

object

raw.response

Create Job Update Job

⌘I

Getting Started

Use Cases

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response