Custom and standard fields are not returned in API response

Posted by Anonymous (not verified) on in General discussion

I am accessing the below API with filters.

https://api.icims.com/customers/{customerId}/people/{peopleid}?fields=externalid,firstname,middlename,lastname,PreferredName,addresses,phones,email,gender,birthdate,race,startdate,usssn,rcf4003,job,rcf4003,rcf2006,drivinglicensenumber,drivinglicensestate

I am not getting the customfields in the response even though they are getting displayed in UI.

Sample Response:

"birthdate": "Information Complete",
"gender": "Information Complete",
"race": "Information Complete"

Not sure what "Information Complete" mean and also some of the standard fields like external id is also missing in the response.

Please let me know how to retrieve the elements that are specified in the data model.

Submitted by iCIMSUNIFIL on April 07, 2022 Permalink

Not able to fetch any data in Recruiting workflow. Response would be empty.
Url being used:
https://api.icims.com/customers/12533/applicantworkflows/47?fields=offeramount
Trying to fetch all the below fields:
bonus, offeramount, proposedstartdate but not able to fetch any of them.

Submitted by iCIMSUNIFIL on December 07, 2023 Permalink

If the response is empty the fields have not been completed on the profile you are retrieving. If you get 'not accessible' the fields are hidden from your API user. If you receive "Information Complete" for PII data teh is a view EEO data setting that must be updated for the API user. 

Submitted by RamprasadB on June 28, 2024 Permalink

Here is how I did it, I couldn't find any better way.

 

Call the Search api for applicantworkflows for a given job id to get the list of candidates that have accepted the offer and use this to calculate the number of remaining openings.

 

https://api.icims.com/customers/XXXXX/search/applicantworkflows

'{"filters":[{"name":"applicantworkflow.job.id","value":["<job id>"],"operator":"="},{"name":"applicantworkflow.status","value":["C27794","D10024","D10034","C15214","D10023"],"operator":"="}],"operator":"&"}'.