BIbindbee
EEOC

Get Eeoc By Id

Changed on

Returns an EEOC record with the given id.

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

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time 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.

racestring 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.

genderstring 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_statusstring 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_statusstring 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"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the AMERICAN_INDIAN_OR_ALASKA_NATIVE enum value from the response property for the response status

    • info

      removed the ASIAN_OR_INDIAN_SUBCONTINENT enum value from the response property for the response status

    • info

      removed the BLACK_OR_AFRICAN_AMERICAN enum value from the response property for the response status

    • info

      removed the DISABLED_INDIVIDUAL enum value from the response property for the response status

    • info

      removed the DISABLED_VETERAN enum value from the response property for the response status

    • info

      removed the FEMALE enum value from the response property for the response status

    • info

      removed the HISPANIC_OR_LATINO enum value from the response property for the response status

    • info

      removed the I_AM_NOT_A_PROTECTED_VETERAN enum value from the response property for the response status

    • info

      removed the I_DONT_WISH_TO_ANSWER enum value from the response property for the response status

    • info

      removed the I_DONT_WISH_TO_ANSWER enum value from the response property for the response status

    • info

      removed the I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN enum value from the response property for the response status

    • info

      removed the MALE enum value from the response property for the response status

    • info

      removed the NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER enum value from the response property for the response status

    • info

      removed the NON-BINARY enum value from the response property for the response status

    • info

      removed the NO_I_DONT_HAVE_A_DISABILITY enum value from the response property for the response status

    • info

      removed the ONE_YEAR_RECENTLY_SEPARATED_VETERAN enum value from the response property for the response status

    • info

      removed the OTHER enum value from the response property for the response status

    • info

      removed the OTHER_PROTECTED_VETERAN enum value from the response property for the response status

    • info

      removed the PREFER_NOT_TO_DISCLOSE enum value from the response property for the response status

    • info

      removed the PREFER_NOT_TO_DISCLOSE enum value from the response property for the response status

    • info

      removed the SPECIAL_DISABLED_VETERAN enum value from the response property for the response status

    • info

      removed the THREE_YEAR_RECENTLY_SEPARATED_VETERAN enum value from the response property for the response status

    • info

      removed the TWO_OR_MORE_RACES enum value from the response property for the response status

    • info

      removed the VIETNAM_ERA_VETERAN enum value from the response property for the response status

    • info

      removed the WHITE enum value from the response property for the response status

    • info

      removed the YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API