Skip to main content
GET
Get Job By Id

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<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

Include raw data in the response

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

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.

Example:

"manager[first_name,last_name]"

Response

Successful Response

The AtsJob object represents a job posting within the ATS.

id
string<uuid>
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
Custom Fields · object | null
required

The custom fields related to the model

Example:
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
enum<string>
required

The current status of the job posting. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
OPEN,
CLOSED,
DRAFT,
ARCHIVED,
PENDING,
-
Example:

"OPEN"

job_posting_urls
AtsUrl · 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"

offices
any[] | null
required

A list of office identifiers where the job is located.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

hiring_managers
any[] | null
required

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

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

recruiters
any[] | null
required

A list of identifiers for recruiters associated with the job.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

raw_data
Raw Data · object | null

This is the Raw data

Example: