Eeocs
The
EEOC object is used to represent the Equal Employment Opportunity Commission information for a candidate (race, gender, veteran status, disability status).Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
candidateUUIDOptional
The candidate being represented.
The Candidate object
The
Candidate object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
first_nameStringOptional
The candidate's first name.
last_nameStringOptional
The candidate's last name.
companyStringOptional
The candidate's current company.
titleStringOptional
The candidate's current title.
remote_created_atDateTime (ISO 8601)Optional
When the third party's candidate was created.
remote_updated_atDateTime (ISO 8601)Optional
When the third party's candidate was updated.
last_interaction_atDateTime (ISO 8601)Optional
When the most recent interaction with the candidate occurred.
is_privateBooleanOptional
Whether or not the candidate is private.
can_emailBooleanOptional
Whether or not the candidate can be emailed.
locationsArrayOptional
The candidate's locations.
phone_numbersPhoneNumber[]Required
email_addressesEmailAddress[]Required
urlsUrl[]Required
tagsArrayRequired
Array of
Tag names as strings.applicationsApplication[]Required
Array of
Application object IDs.attachmentsAttachment[]Required
Array of
Attachment object IDs.remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
submitted_atDateTime (ISO 8601)Optional
When the information was submitted.
raceEnumOptional
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. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.genderEnumOptional
The candidate's gender. Possible values include:
MALE, FEMALE, NON-BINARY, OTHER, DECLINE_TO_SELF_IDENTIFY. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.veteran_statusEnumOptional
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. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.disability_statusEnumOptional
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. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/eeocs
https://api.merge.dev/api/ats/v1/eeocs
US
EU
APAC
Returns a list of EEOC objects.
Query & Path Parameters
candidate_idStringOptional
If provided, will only return EEOC info for this candidate.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
remote_idStringOptional
The API provider's ID for the given object.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Fountain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringremote_created_atstringremote_updated_atstringcan_emailbooleanlocationsarrayphone_numbersarrayemail_addressesarrayurlsarraytagsarrayapplicationsarrayattachmentsarraygenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringsubmitted_atDateTime (ISO 8601)
Greenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringcompanystringtitlestringremote_created_atstringremote_updated_atstringlast_interaction_atstringis_privatebooleancan_emailbooleanlocationsarrayphone_numbersarrayemail_addressesarrayurlsarraytagsarrayapplicationsarrayattachmentsarraydisability_statusEnumgenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringsubmitted_atDateTime (ISO 8601)veteran_statusEnum
JazzHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringremote_created_atstringlocationsarrayphone_numbersarrayemail_addressesarrayurlsarraytagsarrayapplicationsarraydisability_statusEnumgenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringveteran_statusEnum
Jobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringcompanystringtitlestringlocationsarrayphone_numbersarrayemail_addressesarrayapplicationsarrayattachmentsarraygenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringsubmitted_atDateTime (ISO 8601)veteran_statusEnum
SAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringcompanystringtitlestringremote_created_atstringremote_updated_atstringis_privatebooleanlocationsarrayphone_numbersarrayemail_addressesarraytagsarrayapplicationsarrayattachmentsarraydisability_statusEnumgenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringveteran_statusEnum
Workday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringcompanystringtitlestringremote_created_atstringremote_updated_atstringis_privatebooleancan_emailbooleanlocationsarrayphone_numbersarrayemail_addressesarraytagsarrayapplicationsarrayattachmentsarraydisability_statusEnumgenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringveteran_statusEnumGET
/eeocs/{id}
https://api.merge.dev/api/ats/v1/eeocs/{id}
US
EU
APAC
Returns an EEOC object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsStringOptional
Deprecated. Use show_enum_origins.
show_enum_originsStringOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Fountain
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringremote_created_atstringremote_updated_atstringcan_emailbooleanlocationsarrayphone_numbersarrayemail_addressesarrayurlsarraytagsarrayapplicationsarrayattachmentsarraygenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringsubmitted_atDateTime (ISO 8601)Greenhouse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringcompanystringtitlestringremote_created_atstringremote_updated_atstringlast_interaction_atstringis_privatebooleancan_emailbooleanlocationsarrayphone_numbersarrayemail_addressesarrayurlsarraytagsarrayapplicationsarrayattachmentsarraydisability_statusEnumgenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringsubmitted_atDateTime (ISO 8601)veteran_statusEnumJazzHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringremote_created_atstringlocationsarrayphone_numbersarrayemail_addressesarrayurlsarraytagsarrayapplicationsarraydisability_statusEnumgenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringveteran_statusEnumJobvite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringcompanystringtitlestringlocationsarrayphone_numbersarrayemail_addressesarrayapplicationsarrayattachmentsarraygenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringsubmitted_atDateTime (ISO 8601)veteran_statusEnumSAP SuccessFactors
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringcompanystringtitlestringremote_created_atstringremote_updated_atstringis_privatebooleanlocationsarrayphone_numbersarrayemail_addressesarraytagsarrayapplicationsarrayattachmentsarraydisability_statusEnumgenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringveteran_statusEnumWorkday
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
candidateUUIDremote_idstringfirst_namestringlast_namestringcompanystringtitlestringremote_created_atstringremote_updated_atstringis_privatebooleancan_emailbooleanlocationsarrayphone_numbersarrayemail_addressesarraytagsarrayapplicationsarrayattachmentsarraydisability_statusEnumgenderEnumraceEnumremote_dataRemoteData[]pathstringdatastringveteran_statusEnum