GET
/
api
/
ats
/
v1
/
eeocs
/
{id}
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/eeocs/{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"
  },
  "candidate": "<any>",
  "submitted_at": "2021-01-01T00:00:00Z",
  "race": "WHITE",
  "gender": "MALE",
  "veteran_status": "DISABLED",
  "disability_status": "YES"
}

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 AtsEEOC object represents the Equal Employment Opportunity Commission (EEOC) related data for a candidate 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"
}
candidate
any | null
required

The candidate associated with the EEOC data.

submitted_at
string | null
required

The ISO date string when the EEOC data was submitted.

Example:

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

race
string | null
required

The race of the candidate as indicated in the EEOC form.

Example:

"WHITE"

gender
string | null
required

The gender of the candidate as indicated in the EEOC form.

Example:

"MALE"

veteran_status
string | null
required

The veteran status of the candidate as indicated in the EEOC form.

Example:

"DISABLED"

disability_status
string | null
required

The disability status of the candidate as indicated in the EEOC form.

Example:

"YES"

raw_data
object | null

This is the Raw data

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