GET
/
api
/
ats
/
v1
/
offers
/
{id}
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/offers/{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"
  },
  "application": "<any>",
  "creator": "<any>",
  "remote_created_at": "2021-01-01T00:00:00Z",
  "closed_at": "2021-01-01T00:00:00Z",
  "sent_at": "2021-01-01T00:00:00Z",
  "start_date": "2021-01-01T00:00:00Z",
  "status": "ACCEPTED"
}

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 AtsOffer object represents a job offer associated with an application 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"
}
application
any | null
required

The identifier of the application to which the offer is related.

creator
any | null
required

The identifier of the user who created the offer.

remote_created_at
string | null
required

The ISO date string when the offer was created in the third-party system.

Example:

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

closed_at
string | null
required

The ISO date string when the offer was closed.

Example:

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

sent_at
string | null
required

The ISO date string when the offer was sent to the candidate.

Example:

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

start_date
string | null
required

The proposed start date for the candidate, as an ISO date string.

Example:

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

status
string | null
required

The current status of the offer.

Example:

"ACCEPTED"

raw_data
object | null

This is the Raw data

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