Pulling iFORM's Through API

Pulling iFORM IDs through the API

When you are ready to pull form data through the API, you can use a GET request or a POST through our search API to retrieve the form ID of the associated candidate. The filter is based on the form name and the candidate’s iCIMS system ID. The form name will be different for each iFORM, so you’ll have four different filters to choose from based on which form you wish to pull data from.
POST
https://api.icims.com/customers/6271/search/forms

Content Type: application/json
Payload:
{"filters":[{"name":"formdata.formid","value":["305"],"operator":"="},{"name":"formdata.person.id","value":[477703],"operator":"="}],"operator":"&"}
Result:
{
searchResults:
[
1]
0:
{
id: 938515
self: "https://api.icims.com/customers/6271/forms/938515"

}
-
-
}

Get Request to pull the full form:
https://api.icims.com/customers/6271/forms/938515.txt

Comments:
1) The sample payload above is specific to the Employment Application iform.
2) 477703 is the system ID of the candidate, which you should have captured in AX during a prior push event in the recruiting workflow.
3) 938515 is the Form ID you’ll need to pull the form data through the API.
4) In the GET request example, I specified a .txt extension to pull the text version of the form. You can also use .PDF or .DOC (for the PDF of Microsoft word version of the document)
GET
https://api.icims.com/customers/6271/search/forms?searchJson=%7B%22filters%22%3A%5B%7B%22name%22%3A%22formdata.formid%22%2C%22value%22%3A%5B%22305%22%5D%2C%22operator%22%3A%22%3D%22%7D%2C%7B%22name%22%3A%22formdata.person.id%22%2C%22value%22%3A%5B477703%5D%2C%22operator%22%3A%22%3D%22%7D%5D%2C%22operator%22%3A%22%26%22%7D

Result (same as a post)
Get Request to pull the full form (same as post from above)