Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
EEOC

Get Eeoc By Id

Returns an EEOC record with the given id.

get/api/ats/v1/eeocs/{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

candidatestring nullable required

The candidate associated with the EEOC data.

submitted_atstring nullable required

The ISO date string when the EEOC data was submitted.

race'AMERICAN_INDIAN_OR_ALASKA_NATIVE' | 'ASIAN_OR_INDIAN_SUBCONTINENT' | 'BLACK_OR_AFRICAN_AMERICAN' | 'HISPANIC_OR_LATINO' | 'NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER' | 'TWO_OR_MORE_RACES' | 'WHITE' | 'PREFER_NOT_TO_DISCLOSE' | '-' nullable required

The race of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.

gender'MALE' | 'FEMALE' | 'NON-BINARY' | 'OTHER' | 'PREFER_NOT_TO_DISCLOSE' | '-' nullable required

The gender of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.

veteran_status'I_DONT_WISH_TO_ANSWER' | 'DISABLED_VETERAN' | 'SPECIAL_DISABLED_VETERAN' | 'VIETNAM_ERA_VETERAN' | 'OTHER_PROTECTED_VETERAN' | 'THREE_YEAR_RECENTLY_SEPARATED_VETERAN' | 'ONE_YEAR_RECENTLY_SEPARATED_VETERAN' | 'DISABLED_INDIVIDUAL' | 'I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN' | 'I_AM_NOT_A_PROTECTED_VETERAN' | '-' nullable required

The veteran status of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.

disability_status'YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY' | 'NO_I_DONT_HAVE_A_DISABILITY' | 'I_DONT_WISH_TO_ANSWER' | '-' nullable required

The disability status of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.

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"
  },
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "submitted_at": "2021-01-01T00:00:00Z",
  "race": "WHITE",
  "gender": "MALE",
  "veteran_status": "DISABLED_VETERAN",
  "disability_status": "YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY"
}