Get Offers - Bindbee Docs

GET

api

ats

offers

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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

Query Parameters

remote_id

string

The third-party API ID of the matching object.

application

string

The application id of the offer

creator

string

The creator of the offer

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.

page_size

integer

default:50

Number of results to return per page. Maximum size is 100.

Required range: 1 <= x <= 1000

cursor

string

The pagination cursor value.

modified_after

string

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

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

cursor

string | null

required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size

integer

required

Indicates the count of items in the response

Example:

50

items

object[]

required

The AtsOffer object represents a job offer associated with an application within the ATS.

items.id

string

required

Example:

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

items.remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

items.modified_at

string

required

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

Example:

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

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

items.application

any | null

required

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

items.creator

any | null

required

The identifier of the user who created the offer.

items.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"

items.closed_at

string | null

required

The ISO date string when the offer was closed.

Example:

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

items.sent_at

string | null

required

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

Example:

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

items.start_date

string | null

required

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

Example:

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

items.status

string | null

required

The current status of the offer.

Example:

"ACCEPTED"

items.raw_data

object | null

This is the Raw data

Example:

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

Get Job By Id Create Offer

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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"
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response