Field Lists

Currently, Search and Match API returns the default fields (entities) in the response (fields in the records array). Now with the fieldList parameter in the Search and Match API request, you can customize the fields in the API response. See the example in Table 1. Simple Search request and response with and without fieldList parameter.

The Default Fields

The default fields (in records array) that are returned in the API response are as follows:

Resume default field lists JD default field lists
id id
score score
CurrentEmployer SubUserId
TotalExperienceInYear JobProfileTitle
CurrentJobProfile Organization
State JobLocationCity
FullName JobLocationState
Country JobLocationCountry
SubUserId Qualification
City

Sample Simple Search Request and Response

Table 1. Simple Search request and response with and without fieldList parameter
Simple Search Request without fieldList Simple Search Response without fieldList

Note: In below API response, the records array contains the default resume fields since fieldList parameter is not passed in the API request.
Simple Search Request with fieldList Simple Search Response with fieldList

Note:
  • In below API response, the records array contains Skill, score, and JobProfile fields since fieldList parameter contains these parameters in the API request.
  • The id, score, and SubUserID are returned in the API response as default for all records array.

Fields that can be passed in fieldList

The following resume fields and JD fields can be passed in the fieldList parameter in the API request.

Resume Fields JD Fields
CurrentJobProfile JobProfile
JobProfile Employer
CurrentEmployer Degree
Employer Skill
Degree TotalExp
Institute City
Skill State
TotalExperienceRange Country
City LanguageKnown
State JobLocation
Country MaximumYearsExperience
ZipCode IndustryType
LanguageKnown ContractDuration
Email Salary
FullName SalaryMaxAmount
TitleName Currency
FirstName Units
MiddleName Domains
LastName StaffingAgency
Gender InterviewType
MaritalStatus InterviewDate
Nationality InterviewTime
Category InterviewLocation
SubCategory JobCode
CurrentSalary JobType
CurrentSalaryCurrency JobShift
CurrentSalaryUnit CertificationsPreferred
ExpectedSalary CertificationsRequired
ExpectedSalaryCurrency JobLocationIsoCountryCode
ExpectedSalaryUnit JobLocationZipCode
TotalExperienceInMonths JobGeoLocation
TotalExperienceInYear PreferredDemographicNationality
ResumeLanguage PreferredDemographicAgeLimit
ResumeCountry
InstituteCity
InstituteState
InstituteCountry
LastInstitute
CurrentEmployerCity
CurrentEmployerState
CurrentEmployerCountry
EmployerCity
EmployerState
EmployerCountry
CurrentJobAlias
CurrentCity
CurrentState
CurrentCountry
PreferredCity
PreferredState
PreferredCountry

Error Codes

The following error code can occur when you use fieldList parameter in the API request.
Error Code Message
2094 Invalid field name 'fieldName'. Available fields are
2095 FieldList must be of array type