Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Job

Get Job By Id

Returns a Job object with the given id.

get/api/ats/v1/jobs/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Include raw data in the response

Include raw data in the response

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

expandstring

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]

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.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

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

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

namestring nullable required

The name of the job.

descriptionstring nullable required

A detailed description of the job.

codestring nullable required

The internal or external code that identifies the job.

status'OPEN' | 'CLOSED' | 'DRAFT' | 'ARCHIVED' | 'PENDING' | '-' nullable 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.

remote_created_atstring nullable required

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

remote_updated_atstring nullable required

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

confidentialboolean nullable required

Whether the job posting is confidential.

Example response

{
  "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",
  "remote_created_at": "2021-01-01T00:00:00Z",
  "remote_updated_at": "2021-01-01T00:00:00Z"
}