GET
/
api
/
ats
/
v1
/
jobs
/
{id}
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/jobs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "name": "SOFTWARE ENGINEER",
  "description": "We are looking for a software engineer to join our team.",
  "code": "SE-2021-01",
  "status": "OPEN",
  "job_posting_urls": [
    "https://www.company.com/careers/software-engineer"
  ],
  "remote_created_at": "2021-01-01T00:00:00Z",
  "remote_updated_at": "2021-01-01T00:00:00Z",
  "confidential": false,
  "departments": [
    "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
    "018b4bfb-5ece-70b1-ad5e-862a9433aa23"
  ],
  "offices": [
    "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
    "018b4bfb-5ece-70b1-ad5e-862a9433aa23"
  ],
  "hiring_managers": [
    "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
    "018b4bfb-5ece-70b1-ad5e-862a9433aa23"
  ],
  "recruiters": [
    "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token
string
required

Path Parameters

id
string
required

Query Parameters

include_raw_data
boolean
default:false

Include raw data in the response

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Response

200
application/json
Successful Response

The AtsJob object represents a job posting within the ATS.

id
string
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields
object | null
required

The custom fields related to the model

Example:
{
  "category_group": "REG",
  "disability_type": "ASBERG",
  "hire_date": "1991-03-16T00:00:00",
  "hire_source": "REFER",
  "nationality": "USA",
  "original_hire_date": "1991-03-16T00:00:00"
}
name
string | null
required

The name of the job.

Example:

"SOFTWARE ENGINEER"

description
string | null
required

A detailed description of the job.

Example:

"We are looking for a software engineer to join our team."

code
string | null
required

The internal or external code that identifies the job.

Example:

"SE-2021-01"

status
string | null
required

The current status of the job posting.

Example:

"OPEN"

job_posting_urls
object[] | null
required

A list of URLs where the job is posted.

Example:
[
  "https://www.company.com/careers/software-engineer"
]
remote_created_at
string | null
required

The ISO date string when the job was first created in the ATS.

Example:

"2021-01-01T00:00:00Z"

remote_updated_at
string | null
required

The ISO date string when the job was last updated in the ATS.

Example:

"2021-01-01T00:00:00Z"

confidential
boolean | null
required

Whether the job posting is confidential.

Example:

false

departments
any[] | null
required

A list of department identifiers associated with the job.

Example:
[
  "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "018b4bfb-5ece-70b1-ad5e-862a9433aa23"
]
offices
any[] | null
required

A list of office identifiers where the job is located.

Example:
[
  "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "018b4bfb-5ece-70b1-ad5e-862a9433aa23"
]
hiring_managers
any[] | null
required

A list of identifiers for hiring managers associated with the job.

Example:
[
  "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "018b4bfb-5ece-70b1-ad5e-862a9433aa23"
]
recruiters
any[] | null
required

A list of identifiers for recruiters associated with the job.

Example:
["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]
raw_data
object | null

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}