Eeocs

The EEOC object is used to represent the Equal Employment Opportunity Commission information for a candidate (race, gender, veteran status, disability status).

The EEOC object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
candidateString
Optional
The candidate being represented.
submitted_atString
Optional
When the information was submitted.
raceEnum
Optional
The candidate's race. Possible values include: AMERICAN_INDIAN_OR_ALASKAN_NATIVE, ASIAN, BLACK_OR_AFRICAN_AMERICAN, HISPANIC_OR_LATINO, WHITE, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, TWO_OR_MORE_RACES, DECLINE_TO_SELF_IDENTIFY, or - in cases where there is no clear mapping - the original value passed through.
genderEnum
Optional
The candidate's gender. Possible values include: MALE, FEMALE, NON-BINARY, OTHER, DECLINE_TO_SELF_IDENTIFY, or - in cases where there is no clear mapping - the original value passed through.
veteran_statusEnum
Optional
The candidate's veteran status. Possible values include: I_AM_NOT_A_PROTECTED_VETERAN, I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN, I_DONT_WISH_TO_ANSWER, or - in cases where there is no clear mapping - the original value passed through.
disability_statusEnum
Optional
The candidate's disability status. Possible values include: YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY, NO_I_DONT_HAVE_A_DISABILITY, I_DONT_WISH_TO_ANSWER, or - in cases where there is no clear mapping - the original value passed through.
remote_dataRemoteData[]
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
field_mappingsObject
Optional
The EEOC object
JSON
{
  "id": "f7dd7b4f-237e-4772-8bd4-3246384c6c58",
  "remote_id": "76",
  "candidate": "f963f34d-3d2f-4f77-b557-cf36bc7e6498",
  "submitted_at": "2021-10-15T00:00:00Z",
  "race": "HISPANIC_OR_LATINO",
  "gender": "FEMALE",
  "veteran_status": "I_AM_NOT_A_PROTECTED_VETERAN",
  "disability_status": "I_DONT_WISH_TO_ANSWER",
  "remote_data": [
    {
      "path": "/eeoc",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  }
}
GET

/eeocs

Returns a list of EEOC objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

candidate_idString
Optional
If provided, will only return EEOC info for this candidate.
created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
page_sizeInteger
Optional
Number of results to return per page.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
remote_idString
Optional
The API provider's ID for the given object.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "f7dd7b4f-237e-4772-8bd4-3246384c6c58",
      "remote_id": "76",
      "candidate": "f963f34d-3d2f-4f77-b557-cf36bc7e6498",
      "submitted_at": "2021-10-15T00:00:00Z",
      "race": "HISPANIC_OR_LATINO",
      "gender": "FEMALE",
      "veteran_status": "I_AM_NOT_A_PROTECTED_VETERAN",
      "disability_status": "I_DONT_WISH_TO_ANSWER",
      "remote_data": [
        {
          "path": "/eeoc",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "remote_was_deleted": true,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      }
    }
  ]
}
Field support by platform

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
submitted_atString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
disability_statusEnum
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
submitted_atString
veteran_statusEnum

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
disability_statusEnum
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
veteran_statusEnum

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
submitted_atString
veteran_statusEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
disability_statusEnum
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
veteran_statusEnum
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/eeocs/{id}

Returns an EEOC object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "id": "f7dd7b4f-237e-4772-8bd4-3246384c6c58",
  "remote_id": "76",
  "candidate": "f963f34d-3d2f-4f77-b557-cf36bc7e6498",
  "submitted_at": "2021-10-15T00:00:00Z",
  "race": "HISPANIC_OR_LATINO",
  "gender": "FEMALE",
  "veteran_status": "I_AM_NOT_A_PROTECTED_VETERAN",
  "disability_status": "I_DONT_WISH_TO_ANSWER",
  "remote_data": [
    {
      "path": "/eeoc",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  }
}
Field support by platform

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
submitted_atString

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
disability_statusEnum
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
submitted_atString
veteran_statusEnum

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
disability_statusEnum
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
veteran_statusEnum

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
submitted_atString
veteran_statusEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
disability_statusEnum
genderEnum
raceEnum
remote_dataRemoteData[]
pathstring
dataobject
veteran_statusEnum
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Departments

Next Up

Interviews