Create Job

curl --request POST \
  --url https://api.stackone.com/unified/ats/jobs \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "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"
  ],
  "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"
    }
  ],
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
'

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}

POST

unified

ats

jobs

Create Job

curl --request POST \
  --url https://api.stackone.com/unified/ats/jobs \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "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"
  ],
  "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"
    }
  ],
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
'

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}

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

Body

application/json

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

code

string | null

Code of the job

Example:

"184919"

title

string | null

Title of the job

Example:

"Software Engineer"

description

string | null

Description of the job

Example:

"Responsible for identifying business requirements"

status

string | null

deprecated

Status of the job

Example:

"archived"

job_status

object

Status of the job

Show child attributes

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"

job_status.source_value

The source value of the job status.

Example:

"Published"

department_ids

string[] | null

Department ids of the job

Example:

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

location_ids

string[] | null

Location ids of the job

Example:

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

hiring_team

object[] | null

Hiring team for the job.

Show child attributes

hiring_team.user_id

string | null

User ID of the hiring team member.

Example:

"123456"

hiring_team.remote_user_id

string | null

Provider's unique identifier of the user

Example:

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

hiring_team.first_name

string | null

First name of the hiring team member.

Example:

"John"

hiring_team.last_name

string | null

Last name of the hiring team member.

Example:

"Doe"

hiring_team.email

string | null

Email of the hiring team member.

Example:

"[email protected]"

hiring_team.role

string | null

Role of the hiring team member.

Example:

"Software Engineer"

interview_stages

object[] | null

Interview stages for the job.

Show child attributes

interview_stages.id

string | null

Unique identifier

Example:

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

interview_stages.remote_id

string | null

Provider's unique identifier

Example:

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

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

interview_stages.name

string | null

interview_stages.order

number | null

interview_stages.created_at

string<date-time> | null

Interview Stage created date

Example:

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

interview_stages.updated_at

string<date-time> | null

Interview Stage updated date

Example:

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

confidential

enum<string> | null

Confidential status of the job

Available options:

true,

false,

unmapped_value,

custom_fields

object[] | null

The job custom fields

Show child attributes

custom_fields.id

string | null

Unique identifier

Example:

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

custom_fields.remote_id

string | null

Provider's unique identifier

Example:

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

custom_fields.name

string | null

The name of the custom field.

Example:

"Training Completion Status"

custom_fields.value

The value associated with the custom field.

Example:

"Completed"

custom_fields.value_id

string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

custom_fields.remote_value_id

string | null

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

Example:

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

passthrough

object

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

Response

The job was successfully created.

statusCode

number

required

Example:

201

message

string

required

Example:

"Record created successfully."

timestamp

string<date-time>

required

Example:

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

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"

List Jobs Get Job

⌘I

Getting Started

Use Cases

API Reference

Create Job

Authorizations

Headers

Body

Response