Selecting individual fields with the Search API

Posted by Anonymous (not verified) on in General discussion

I am trying to retrieve specified fields from the Search API as documented (https://developer.icims.com/REST-API/Object-Types-Commands/Search-API), but the response only includes FirstName, LastName, Hire Date, Phone #'s, and Addresses, and not any of the specified fields. Here is an example of the Get request:

https://api.icims.com/customers//people/?fields=firstname,middlename,lastname,field28556,field31362,field32912,email,gender,ssn,birthdate,race,usssn,phones,addresses,hiredate,startdate,federalexemptions,federalwithholdingtype,federalmaritalstatus

I would appreciate any guidance as to how to get a response that includes something other than the default fields.

Submitted by iCIMSUNIFIL on July 22, 2021 Permalink

Search results are always returned as a System ID. Vendors are responsible for targeting these specific profiles if they need further information about these profiles. A GET request using the Search API requires encoded filters in the URL. GET: https://api.icims.com/customers/{customerID}/search/{profileType}?searchJson={EncodedFilters...}. If you are using the Person Profile API and issuing a GET request make sure your API user has access to all the fields. The client user admin or iCIMS resource will need to un-hide the fields. If you do have access make sure there is data in the fields for the profile you are requesting.

Submitted by iCIMSUNIFIL on November 11, 2021 Permalink

searchJson will search for the value in response. How to make sure response gives value for custom field? I am struggling with running below GET..it never returns any custom field value even though the field has value stored in it.
https://api.icims.com/customers//people/237527?fields=firstname,lastname,middlename,field2146