iCIMS
App · 24 actions
Work with iCIMS recruiting: find, add and update candidates and jobs, move applications through your statuses, post jobs, and start workflows when people, jobs or applications are added or change.
Actions
| Action | What it does |
|---|---|
| Add candidate to job | Put a person into a job's recruiting workflow (an application), at a status and with a source if given, and return the application. |
| Create job | Add a job to iCIMS and return it. |
| Create person | Add a person, such as a candidate, to iCIMS and return their profile. |
| Find a person's application to a job | Find the application of one person to one job, if they have applied. |
| Find applications | Find applications (candidates in a job's recruiting workflow) by job, person, status or when they changed, with their status. |
| Find by external ID | Find the iCIMS id of the person, job or company that has an external ID (the id another system gave it). |
| Find companies and locations | Find companies and locations by name, city or the dates they were added or changed, with their details. |
| Find jobs | Find jobs by title, job code, folder or the dates they were added or changed, with their details. |
| Find people | Find people (candidates, employees and users) by name, email, folder or the dates they were added or changed, with their details. |
| Find talent pools | Find talent pools by title or the dates they were added or changed. |
| Get application | Get one application: its job, candidate, status and source, and its last 100 status changes if asked. |
| Get company or location | Get one company or location: name, email, folder and addresses. |
| Get job | Get one job: title, job code, folder, hiring manager, recruiter, owner, location and openings, or the fields you name. |
| Get list values | List the values of an iCIMS list, such as person or job folders, with the ids other steps take (a folder, a status). |
| Get person | Get one person's profile: name, email, folder, phones and addresses, or the fields you name. |
| Get profile fields | List every field of a kind of iCIMS profile, your own custom fields included, with the names Fields and Other fields take. |
| Get talent pool | Get one talent pool: title, external ID, owner and folder. |
| List job posts | List the career sites a job is posted on, with each post's status and start date. |
| Post job to career site | Post an approved job to one of your iCIMS career sites, publicly, from a start time to an end time if given. |
| Remove candidate from job | Delete an application, taking the person out of the job's recruiting workflow. |
| Take job off career site | Take a posted job off one of your iCIMS career sites. |
| Update application | Move an application to another status, or change its source or other fields, and return it. |
| Update job | Change a job's title, folder, people, openings, overview or other fields, and return it. |
| Update person | Change a person's name, email, folder or other fields, and return their profile. |
Add candidate to job
Put a person into a job's recruiting workflow (an application), at a status and with a source if given, and return the application.
Inputs
- Job ID
job_idtextRequired - The job's iCIMS system id, from 'Find jobs' or a trigger.
- Person ID
person_idtextRequired - The person's iCIMS system id, from 'Find people' or a trigger.
- Status ID
status_idtext - The status to start at. Leave empty for the job's first status. The status's id in iCIMS, such as D10100 or C12345. Find your statuses' ids with 'Get list values'.
- Source
sourcetext - Where the candidate came from, such as a job board.
Outputs
applicationobject- An application: a candidate's place in a job's recruiting workflow
idnumber- The application's iCIMS system id
Example output
{
"application": {
"associatedprofile": {
"id": 5,
"profile": "https://api.icims.com/customers/1234/people/5/",
"value": "John Smith"
},
"baseprofile": {
"id": 3,
"profile": "https://api.icims.com/customers/1234/jobs/3/",
"value": "Accountant"
},
"createddate": "2026-03-01 09:12 AM",
"id": 13,
"job_id": 3,
"job_title": "Accountant",
"person_id": 5,
"person_name": "John Smith",
"source": "ICIMS.com",
"sourcename": "Internal",
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"status_id": "D5432",
"status_name": "Interview Scheduled",
"submittalstatuslog": [
{
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"updatedBy": {
"id": 1,
"profile": "",
"value": "iAdmin"
},
"updatedDate": "2026-03-02 10:41:11"
}
],
"updateddate": "2026-03-02 10:41 AM"
},
"id": 13
}Create job
Add a job to iCIMS and return it.
Inputs
- Job title
job_titletextRequired - The job's title, up to 256 characters.
- Folder
foldertext - The job's folder, such as Approved or Draft.
- Hiring manager ID
hiring_manager_idtext - The hiring manager's person id in iCIMS.
- Recruiter ID
recruiter_idtext - The recruiter's person id in iCIMS.
- Job owner ID
job_owner_idtext - The job owner's person id in iCIMS.
- Number of openings
number_of_openingsnumber - How many people the job will hire.At least 0.
- Overview
overviewtext - The job's overview, as text or HTML.
- Other fields
other_fieldsobject - Any other iCIMS fields to set, by their iCIMS name, such as externalid or a custom field1234. A list field takes its value's id, as {"id": "C12345"}; a link to a person takes their id.
Outputs
idnumber- The job's iCIMS system id
jobobject- A job
Example output
{
"id": 1026,
"job": {
"createddate": "2026-02-01 08:00 AM",
"folder": {
"formattedvalue": "Approved",
"id": "D31001",
"value": "Approved"
},
"hiringmanager": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"id": 1026,
"jobid": "2026-1026",
"joblocation": {
"companyid": 6,
"id": 5,
"value": "Chicago, Illinois"
},
"jobnumber": "ENG-42",
"jobowner": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"jobtitle": "Senior Software Engineer",
"numberofpositions": 2,
"recruiter": {
"id": 95,
"profile": "https://api.icims.com/customers/1234/people/95",
"value": "Gabe Velazquez"
},
"updateddate": "2026-03-02 10:41 AM"
}
}Create person
Add a person, such as a candidate, to iCIMS and return their profile.
Inputs
- First name
first_nametextRequired - The person's first name.
- Last name
last_nametextRequired - The person's last name.
- Email
emailtext - The person's email address.
- Middle name
middle_nametext - The person's middle name.
- Folder
foldertext - The person's folder, such as a candidate or employee folder.
- Other fields
other_fieldsobject - Any other iCIMS fields to set, by their iCIMS name, such as externalid or a custom field1234. A list field takes its value's id, as {"id": "C12345"}; a link to a person takes their id.
Outputs
idnumber- The person's iCIMS system id
personobject- A person (candidate, employee or user)
Example output
{
"id": 5,
"person": {
"addresses": [
{
"addresscity": "Hazlet",
"addresscountry": {
"formattedvalue": "United States",
"id": "D41001",
"value": "United States"
},
"addressstate": {
"formattedvalue": "NJ",
"id": "D41001031",
"value": "NJ"
},
"addressstreet1": "1 Main St",
"addressstreet2": "",
"addresstype": {
"formattedvalue": "Home",
"id": "D84006",
"value": "Home"
},
"addresszip": "07730",
"entry": 1
}
],
"createddate": "2026-03-01 09:12 AM",
"email": "john.smith@example.com",
"firstname": "John",
"folder": {
"formattedvalue": "Cand:Unreviewed",
"id": "D32006",
"value": "Cand:Unreviewed"
},
"id": 5,
"lastname": "Smith",
"middlename": "",
"phones": [
{
"entry": 1,
"phoneextension": "233",
"phonenumber": "212-555-5555",
"phonetype": {
"formattedvalue": "Home",
"id": "D84002",
"value": "Home"
}
}
],
"updateddate": "2026-03-02 10:41 AM"
}
}Find a person's application to a job
Find the application of one person to one job, if they have applied.
Inputs
- Person ID
person_idtextRequired - The person's iCIMS system id, from 'Find people' or a trigger.
- Job ID
job_idtextRequired - The job's iCIMS system id, from 'Find jobs' or a trigger.
Outputs
applicationobject- An application: a candidate's place in a job's recruiting workflow
foundtrue/false- True if they have applied
Example output
{
"application": {
"associatedprofile": {
"id": 5,
"profile": "https://api.icims.com/customers/1234/people/5/",
"value": "John Smith"
},
"baseprofile": {
"id": 3,
"profile": "https://api.icims.com/customers/1234/jobs/3/",
"value": "Accountant"
},
"createddate": "2026-03-01 09:12 AM",
"id": 13,
"job_id": 3,
"job_title": "Accountant",
"person_id": 5,
"person_name": "John Smith",
"source": "ICIMS.com",
"sourcename": "Internal",
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"status_id": "D5432",
"status_name": "Interview Scheduled",
"submittalstatuslog": [
{
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"updatedBy": {
"id": 1,
"profile": "",
"value": "iAdmin"
},
"updatedDate": "2026-03-02 10:41:11"
}
],
"updateddate": "2026-03-02 10:41 AM"
},
"found": true
}Find applications
Find applications (candidates in a job's recruiting workflow) by job, person, status or when they changed, with their status. Lowest iCIMS id first; to read on, run it again with the next_after_id it gives.
Inputs
- Job ID
job_idtext - Only applications to this job.
- Person ID
person_idtext - Only this person's applications.
- Status ID
status_idtext - Only applications at this status. The status's id in iCIMS, such as D10100 or C12345. Find your statuses' ids with 'Get list values'.
- Updated after
updated_afterdate and time - Only applications changed at or after this time.
- Updated before
updated_beforedate and time - Only applications changed before this time.
- How many
limitnumber - How many to return, 1 to 100. Defaults to 25. Each one is a call to iCIMS.From 1 to 100.
- Start after ID
after_idtext - Only those with a higher iCIMS id than this. Use the 'next_after_id' an earlier run gave to read on.
Outputs
applicationslist- The applications found
countnumber- How many were returned
idslist- Their iCIMS system ids, lowest first
next_after_idnumber- When there are more, the id to give as Start after ID to read on; empty when there are none
Example output
{
"applications": [
{
"associatedprofile": {
"id": 5,
"profile": "https://api.icims.com/customers/1234/people/5/",
"value": "John Smith"
},
"baseprofile": {
"id": 3,
"profile": "https://api.icims.com/customers/1234/jobs/3/",
"value": "Accountant"
},
"createddate": "2026-03-01 09:12 AM",
"id": 13,
"job_id": 3,
"job_title": "Accountant",
"person_id": 5,
"person_name": "John Smith",
"source": "ICIMS.com",
"sourcename": "Internal",
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"status_id": "D5432",
"status_name": "Interview Scheduled",
"submittalstatuslog": [
{
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"updatedBy": {
"id": 1,
"profile": "",
"value": "iAdmin"
},
"updatedDate": "2026-03-02 10:41:11"
}
],
"updateddate": "2026-03-02 10:41 AM"
}
],
"count": 1,
"ids": [
13
],
"next_after_id": null
}Find by external ID
Find the iCIMS id of the person, job or company that has an external ID (the id another system gave it).
Inputs
- Look for a
profile_typetextRequired - Whether the external ID is a person's, a job's or a company's.One of:
people(Person),jobs(Job),companies(Company or location). - External ID
external_idtextRequired - The external ID, as saved in the profile's External ID field.
Outputs
foundtrue/false- True if a profile has it
idnumber- The profile's iCIMS system id, when found
profile_typetext- people, jobs or companies
Example output
{
"found": true,
"id": 1013,
"profile_type": "people"
}Find companies and locations
Find companies and locations by name, city or the dates they were added or changed, with their details. Lowest iCIMS id first; to read on, run it again with the next_after_id it gives.
Inputs
- Name
nametext - Only those whose name has this.
- City
citytext - Only those with an address in this city.
- Created after
created_afterdate and time - Only companies added at or after this time.
- Created before
created_beforedate and time - Only companies added before this time.
- Updated after
updated_afterdate and time - Only companies changed at or after this time.
- Updated before
updated_beforedate and time - Only companies changed before this time.
- Fields
fieldstext - The iCIMS fields to return, by name and separated by commas, such as firstname,lastname,email,field1234. Leave empty for the basic fields. 'Get profile fields' lists every field's name.
- How many
limitnumber - How many to return, 1 to 100. Defaults to 25. Each one is a call to iCIMS.From 1 to 100.
- Start after ID
after_idtext - Only those with a higher iCIMS id than this. Use the 'next_after_id' an earlier run gave to read on.
Outputs
companieslist- The companies found
countnumber- How many were returned
idslist- Their iCIMS system ids, lowest first
next_after_idnumber- When there are more, the id to give as Start after ID to read on; empty when there are none
Example output
{
"companies": [
{
"addresses": [],
"createddate": "2025-01-10 09:00 AM",
"email": "chicago@example.com",
"folder": {
"formattedvalue": "Active",
"id": "D33001",
"value": "Active"
},
"id": 6,
"name": "Chicago office",
"updateddate": "2026-01-10 09:00 AM"
}
],
"count": 1,
"ids": [
6
],
"next_after_id": null
}Find jobs
Find jobs by title, job code, folder or the dates they were added or changed, with their details. Lowest iCIMS id first; to read on, run it again with the next_after_id it gives.
Inputs
- Job title
job_titletext - Only jobs whose title has this.
- Job code
job_numbertext - Only jobs whose job code has this.
- Folder
foldertext - Only jobs in this folder, such as Approved.
- Created after
created_afterdate and time - Only jobs added at or after this time.
- Created before
created_beforedate and time - Only jobs added before this time.
- Updated after
updated_afterdate and time - Only jobs changed at or after this time.
- Updated before
updated_beforedate and time - Only jobs changed before this time.
- Fields
fieldstext - The iCIMS fields to return, by name and separated by commas, such as firstname,lastname,email,field1234. Leave empty for the basic fields. 'Get profile fields' lists every field's name.
- How many
limitnumber - How many to return, 1 to 100. Defaults to 25. Each one is a call to iCIMS.From 1 to 100.
- Start after ID
after_idtext - Only those with a higher iCIMS id than this. Use the 'next_after_id' an earlier run gave to read on.
Outputs
countnumber- How many were returned
idslist- Their iCIMS system ids, lowest first
jobslist- The jobs found
next_after_idnumber- When there are more, the id to give as Start after ID to read on; empty when there are none
Example output
{
"count": 1,
"ids": [
1026
],
"jobs": [
{
"createddate": "2026-02-01 08:00 AM",
"folder": {
"formattedvalue": "Approved",
"id": "D31001",
"value": "Approved"
},
"hiringmanager": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"id": 1026,
"jobid": "2026-1026",
"joblocation": {
"companyid": 6,
"id": 5,
"value": "Chicago, Illinois"
},
"jobnumber": "ENG-42",
"jobowner": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"jobtitle": "Senior Software Engineer",
"numberofpositions": 2,
"recruiter": {
"id": 95,
"profile": "https://api.icims.com/customers/1234/people/95",
"value": "Gabe Velazquez"
},
"updateddate": "2026-03-02 10:41 AM"
}
],
"next_after_id": null
}Find people
Find people (candidates, employees and users) by name, email, folder or the dates they were added or changed, with their details. Lowest iCIMS id first; to read on, run it again with the next_after_id it gives.
Inputs
- First name
first_nametext - Only people whose first name has this.
- Last name
last_nametext - Only people whose last name has this.
- Email
emailtext - Only the people with this email address.
- Folder
foldertext - Only people in this folder.
- Created after
created_afterdate and time - Only people added at or after this time.
- Created before
created_beforedate and time - Only people added before this time.
- Updated after
updated_afterdate and time - Only people changed at or after this time.
- Updated before
updated_beforedate and time - Only people changed before this time.
- Fields
fieldstext - The iCIMS fields to return, by name and separated by commas, such as firstname,lastname,email,field1234. Leave empty for the basic fields. 'Get profile fields' lists every field's name.
- How many
limitnumber - How many to return, 1 to 100. Defaults to 25. Each one is a call to iCIMS.From 1 to 100.
- Start after ID
after_idtext - Only those with a higher iCIMS id than this. Use the 'next_after_id' an earlier run gave to read on.
Outputs
countnumber- How many were returned
idslist- Their iCIMS system ids, lowest first
next_after_idnumber- When there are more, the id to give as Start after ID to read on; empty when there are none
peoplelist- The people found
Example output
{
"count": 1,
"ids": [
5
],
"next_after_id": null,
"people": [
{
"addresses": [
{
"addresscity": "Hazlet",
"addresscountry": {
"formattedvalue": "United States",
"id": "D41001",
"value": "United States"
},
"addressstate": {
"formattedvalue": "NJ",
"id": "D41001031",
"value": "NJ"
},
"addressstreet1": "1 Main St",
"addressstreet2": "",
"addresstype": {
"formattedvalue": "Home",
"id": "D84006",
"value": "Home"
},
"addresszip": "07730",
"entry": 1
}
],
"createddate": "2026-03-01 09:12 AM",
"email": "john.smith@example.com",
"firstname": "John",
"folder": {
"formattedvalue": "Cand:Unreviewed",
"id": "D32006",
"value": "Cand:Unreviewed"
},
"id": 5,
"lastname": "Smith",
"middlename": "",
"phones": [
{
"entry": 1,
"phoneextension": "233",
"phonenumber": "212-555-5555",
"phonetype": {
"formattedvalue": "Home",
"id": "D84002",
"value": "Home"
}
}
],
"updateddate": "2026-03-02 10:41 AM"
}
]
}Find talent pools
Find talent pools by title or the dates they were added or changed. Lowest iCIMS id first; to read on, run it again with the next_after_id it gives.
Inputs
- Title
titletext - Only talent pools whose title has this.
- Created after
created_afterdate and time - Only talent pools added at or after this time.
- Created before
created_beforedate and time - Only talent pools added before this time.
- Updated after
updated_afterdate and time - Only talent pools changed at or after this time.
- Updated before
updated_beforedate and time - Only talent pools changed before this time.
- How many
limitnumber - How many to return, 1 to 100. Defaults to 25. Each one is a call to iCIMS.From 1 to 100.
- Start after ID
after_idtext - Only those with a higher iCIMS id than this. Use the 'next_after_id' an earlier run gave to read on.
Outputs
countnumber- How many were returned
idslist- Their iCIMS system ids, lowest first
next_after_idnumber- When there are more, the id to give as Start after ID to read on; empty when there are none
talent_poolslist- The talent pools found
Example output
{
"count": 1,
"ids": [
21
],
"next_after_id": null,
"talent_pools": [
{
"createddate": "2025-06-01 09:00 AM",
"externalid": "TP-21",
"folder": {
"formattedvalue": "Active",
"id": "D36001",
"value": "Active"
},
"id": 21,
"owner": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"title": "Engineering silver medalists",
"updateddate": "2026-01-10 09:00 AM"
}
]
}Get application
Get one application: its job, candidate, status and source, and its last 100 status changes if asked.
Inputs
- Application ID
application_idtextRequired - The application's iCIMS system id, from 'Find applications' or a trigger.
- Include status history
include_status_historytrue/false - Turn on to add the last 100 status changes, with who made each.
Outputs
applicationobject- An application: a candidate's place in a job's recruiting workflow
Example output
{
"application": {
"associatedprofile": {
"id": 5,
"profile": "https://api.icims.com/customers/1234/people/5/",
"value": "John Smith"
},
"baseprofile": {
"id": 3,
"profile": "https://api.icims.com/customers/1234/jobs/3/",
"value": "Accountant"
},
"createddate": "2026-03-01 09:12 AM",
"id": 13,
"job_id": 3,
"job_title": "Accountant",
"person_id": 5,
"person_name": "John Smith",
"source": "ICIMS.com",
"sourcename": "Internal",
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"status_id": "D5432",
"status_name": "Interview Scheduled",
"submittalstatuslog": [
{
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"updatedBy": {
"id": 1,
"profile": "",
"value": "iAdmin"
},
"updatedDate": "2026-03-02 10:41:11"
}
],
"updateddate": "2026-03-02 10:41 AM"
}
}Get company or location
Get one company or location: name, email, folder and addresses.
Inputs
- Company ID
company_idtextRequired - The company's iCIMS system id, from 'Find companies and locations'.
- Fields
fieldstext - The iCIMS fields to return, by name and separated by commas, such as firstname,lastname,email,field1234. Leave empty for the basic fields. 'Get profile fields' lists every field's name.
Outputs
companyobject- A company or location
Example output
{
"company": {
"addresses": [],
"createddate": "2025-01-10 09:00 AM",
"email": "chicago@example.com",
"folder": {
"formattedvalue": "Active",
"id": "D33001",
"value": "Active"
},
"id": 6,
"name": "Chicago office",
"updateddate": "2026-01-10 09:00 AM"
}
}Get job
Get one job: title, job code, folder, hiring manager, recruiter, owner, location and openings, or the fields you name.
Inputs
- Job ID
job_idtextRequired - The job's iCIMS system id, from 'Find jobs' or a trigger.
- Fields
fieldstext - The iCIMS fields to return, by name and separated by commas, such as firstname,lastname,email,field1234. Leave empty for the basic fields. 'Get profile fields' lists every field's name.
Outputs
jobobject- A job
Example output
{
"job": {
"createddate": "2026-02-01 08:00 AM",
"folder": {
"formattedvalue": "Approved",
"id": "D31001",
"value": "Approved"
},
"hiringmanager": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"id": 1026,
"jobid": "2026-1026",
"joblocation": {
"companyid": 6,
"id": 5,
"value": "Chicago, Illinois"
},
"jobnumber": "ENG-42",
"jobowner": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"jobtitle": "Senior Software Engineer",
"numberofpositions": 2,
"recruiter": {
"id": 95,
"profile": "https://api.icims.com/customers/1234/people/95",
"value": "Gabe Velazquez"
},
"updateddate": "2026-03-02 10:41 AM"
}
}Get list values
List the values of an iCIMS list, such as person or job folders, with the ids other steps take (a folder, a status).
Inputs
- List
list_idtextRequired - The iCIMS list, such as lists.person.folders.
- Inside value
parent_value_idtext - For a list with levels: the id of the value whose own values to list. Leave empty for the top level.
Outputs
countnumber- How many values
list_idtext- The list
valueslist- The list's values
Example output
{
"count": 1,
"list_id": "lists.job.folders",
"values": [
{
"hidden": false,
"id": "D31001",
"listnodeid": 31001,
"value": "Approved"
}
]
}Get person
Get one person's profile: name, email, folder, phones and addresses, or the fields you name.
Inputs
- Person ID
person_idtextRequired - The person's iCIMS system id, from 'Find people' or a trigger.
- Fields
fieldstext - The iCIMS fields to return, by name and separated by commas, such as firstname,lastname,email,field1234. Leave empty for the basic fields. 'Get profile fields' lists every field's name.
Outputs
personobject- A person (candidate, employee or user)
Example output
{
"person": {
"addresses": [
{
"addresscity": "Hazlet",
"addresscountry": {
"formattedvalue": "United States",
"id": "D41001",
"value": "United States"
},
"addressstate": {
"formattedvalue": "NJ",
"id": "D41001031",
"value": "NJ"
},
"addressstreet1": "1 Main St",
"addressstreet2": "",
"addresstype": {
"formattedvalue": "Home",
"id": "D84006",
"value": "Home"
},
"addresszip": "07730",
"entry": 1
}
],
"createddate": "2026-03-01 09:12 AM",
"email": "john.smith@example.com",
"firstname": "John",
"folder": {
"formattedvalue": "Cand:Unreviewed",
"id": "D32006",
"value": "Cand:Unreviewed"
},
"id": 5,
"lastname": "Smith",
"middlename": "",
"phones": [
{
"entry": 1,
"phoneextension": "233",
"phonenumber": "212-555-5555",
"phonetype": {
"formattedvalue": "Home",
"id": "D84002",
"value": "Home"
}
}
],
"updateddate": "2026-03-02 10:41 AM"
}
}Get profile fields
List every field of a kind of iCIMS profile, your own custom fields included, with the names Fields and Other fields take.
Inputs
- Profile
profile_typetextRequired - Which kind of profile's fields to list.One of:
person,job,company(Company or location),submittal(Application (recruiting workflow)),sourceworkflow(Sourcing workflow),onboardworkflow(Onboarding workflow),connectevent(Event),room.
Outputs
countnumber- How many fields
fieldslist- Its fields
profile_typetext- The kind of profile
Example output
{
"count": 2,
"fields": [
{
"custom": false,
"format": "",
"name": "jobtitle",
"type": "string"
},
{
"custom": true,
"format": "",
"name": "field17236",
"type": "string"
}
],
"profile_type": "job"
}Get talent pool
Get one talent pool: title, external ID, owner and folder.
Inputs
- Talent pool ID
talent_pool_idtextRequired - The talent pool's iCIMS system id, from 'Find talent pools'.
- Fields
fieldstext - The iCIMS fields to return, by name and separated by commas, such as firstname,lastname,email,field1234. Leave empty for the basic fields. 'Get profile fields' lists every field's name.
Outputs
talent_poolobject- A talent pool
Example output
{
"talent_pool": {
"createddate": "2025-06-01 09:00 AM",
"externalid": "TP-21",
"folder": {
"formattedvalue": "Active",
"id": "D36001",
"value": "Active"
},
"id": 21,
"owner": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"title": "Engineering silver medalists",
"updateddate": "2026-01-10 09:00 AM"
}
}List job posts
List the career sites a job is posted on, with each post's status and start date.
Inputs
- Job ID
job_idtextRequired - The job's iCIMS system id, from 'Find jobs' or a trigger.
Outputs
countnumber- How many posts
job_idnumber- The job's id
job_postslist- The job's posts
Example output
{
"count": 1,
"job_id": 1026,
"job_posts": [
{
"jobpostid": 325,
"portalurl": "careers-example.icims.com",
"startdate": "2026-03-01 1:41 PM",
"status": "Posted"
}
]
}Post job to career site
Post an approved job to one of your iCIMS career sites, publicly, from a start time to an end time if given.
Inputs
- Job ID
job_idtextRequired - The job's iCIMS system id, from 'Find jobs' or a trigger.
- Posted by (person ID)
posted_by_idtextRequired - The person id of the iCIMS user the post is made as, such as the recruiter.
- Career site address
portal_urltextRequired - The career site's address as iCIMS knows it, such as careers-yourcompany.icims.com. 'List job posts' shows the ones a job is on.
- Start
startdate and time - When the post starts. Leave empty for now.
- End
enddate and time - When the post ends. Leave empty to keep it up.
Outputs
job_postobject- A job's posting on a career site
job_post_idnumber- The new post's id
Example output
{
"job_post": {
"jobpostid": 325,
"portalurl": "careers-example.icims.com",
"startdate": "2026-03-01 1:41 PM",
"status": "Posted"
},
"job_post_id": 325
}Remove candidate from job
Delete an application, taking the person out of the job's recruiting workflow. The person and the job stay.
Inputs
- Application ID
application_idtextRequired - The application's iCIMS system id, from 'Find applications' or a trigger.
Outputs
idnumber- The application's id
removedtrue/false- True once it is removed
Example output
{
"id": 13,
"removed": true
}Take job off career site
Take a posted job off one of your iCIMS career sites.
Inputs
- Job ID
job_idtextRequired - The job's iCIMS system id, from 'Find jobs' or a trigger.
- Posted by (person ID)
posted_by_idtextRequired - The person id of the iCIMS user the post is made as, such as the recruiter.
- Career site address
portal_urltextRequired - The career site's address as iCIMS knows it, such as careers-yourcompany.icims.com. 'List job posts' shows the ones a job is on.
Outputs
job_idnumber- The job's id
portal_urltext- The career site
unpostedtrue/false- True once it is taken off
Example output
{
"job_id": 1026,
"portal_url": "careers-example.icims.com",
"unposted": true
}Update application
Move an application to another status, or change its source or other fields, and return it.
Inputs
- Application ID
application_idtextRequired - The application's iCIMS system id, from 'Find applications' or a trigger.
- Status ID
status_idtext - The new status. The status's id in iCIMS, such as D10100 or C12345. Find your statuses' ids with 'Get list values'.
- Source
sourcetext - Where the candidate came from.
- Other fields
other_fieldsobject - Any other iCIMS fields to set, by their iCIMS name, such as externalid or a custom field1234. A list field takes its value's id, as {"id": "C12345"}; a link to a person takes their id.
Outputs
applicationobject- An application: a candidate's place in a job's recruiting workflow
idnumber- The application's iCIMS system id
Example output
{
"application": {
"associatedprofile": {
"id": 5,
"profile": "https://api.icims.com/customers/1234/people/5/",
"value": "John Smith"
},
"baseprofile": {
"id": 3,
"profile": "https://api.icims.com/customers/1234/jobs/3/",
"value": "Accountant"
},
"createddate": "2026-03-01 09:12 AM",
"id": 13,
"job_id": 3,
"job_title": "Accountant",
"person_id": 5,
"person_name": "John Smith",
"source": "ICIMS.com",
"sourcename": "Internal",
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"status_id": "D5432",
"status_name": "Interview Scheduled",
"submittalstatuslog": [
{
"status": {
"formattedvalue": "Interview Scheduled",
"id": "D5432",
"value": "Interview Scheduled"
},
"updatedBy": {
"id": 1,
"profile": "",
"value": "iAdmin"
},
"updatedDate": "2026-03-02 10:41:11"
}
],
"updateddate": "2026-03-02 10:41 AM"
},
"id": 13
}Update job
Change a job's title, folder, people, openings, overview or other fields, and return it. Fields left empty are not changed.
Inputs
- Job ID
job_idtextRequired - The job's iCIMS system id, from 'Find jobs' or a trigger.
- Job title
job_titletext - The job's title, up to 256 characters.
- Folder
foldertext - The job's folder, such as Approved or Draft.
- Hiring manager ID
hiring_manager_idtext - The hiring manager's person id in iCIMS.
- Recruiter ID
recruiter_idtext - The recruiter's person id in iCIMS.
- Job owner ID
job_owner_idtext - The job owner's person id in iCIMS.
- Number of openings
number_of_openingsnumber - How many people the job will hire.At least 0.
- Overview
overviewtext - The job's overview, as text or HTML.
- Other fields
other_fieldsobject - Any other iCIMS fields to set, by their iCIMS name, such as externalid or a custom field1234. A list field takes its value's id, as {"id": "C12345"}; a link to a person takes their id.
Outputs
idnumber- The job's iCIMS system id
jobobject- A job
Example output
{
"id": 1026,
"job": {
"createddate": "2026-02-01 08:00 AM",
"folder": {
"formattedvalue": "Approved",
"id": "D31001",
"value": "Approved"
},
"hiringmanager": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"id": 1026,
"jobid": "2026-1026",
"joblocation": {
"companyid": 6,
"id": 5,
"value": "Chicago, Illinois"
},
"jobnumber": "ENG-42",
"jobowner": {
"id": 564,
"profile": "https://api.icims.com/customers/1234/people/564",
"value": "Philip Chennikkara"
},
"jobtitle": "Senior Software Engineer",
"numberofpositions": 2,
"recruiter": {
"id": 95,
"profile": "https://api.icims.com/customers/1234/people/95",
"value": "Gabe Velazquez"
},
"updateddate": "2026-03-02 10:41 AM"
}
}Update person
Change a person's name, email, folder or other fields, and return their profile. Fields left empty are not changed.
Inputs
- Person ID
person_idtextRequired - The person's iCIMS system id, from 'Find people' or a trigger.
- First name
first_nametext - The person's first name.
- Last name
last_nametext - The person's last name.
- Email
emailtext - The person's email address.
- Middle name
middle_nametext - The person's middle name.
- Folder
foldertext - The person's folder, such as a candidate or employee folder.
- Other fields
other_fieldsobject - Any other iCIMS fields to set, by their iCIMS name, such as externalid or a custom field1234. A list field takes its value's id, as {"id": "C12345"}; a link to a person takes their id.
Outputs
idnumber- The person's iCIMS system id
personobject- A person (candidate, employee or user)
Example output
{
"id": 5,
"person": {
"addresses": [
{
"addresscity": "Hazlet",
"addresscountry": {
"formattedvalue": "United States",
"id": "D41001",
"value": "United States"
},
"addressstate": {
"formattedvalue": "NJ",
"id": "D41001031",
"value": "NJ"
},
"addressstreet1": "1 Main St",
"addressstreet2": "",
"addresstype": {
"formattedvalue": "Home",
"id": "D84006",
"value": "Home"
},
"addresszip": "07730",
"entry": 1
}
],
"createddate": "2026-03-01 09:12 AM",
"email": "john.smith@example.com",
"firstname": "John",
"folder": {
"formattedvalue": "Cand:Unreviewed",
"id": "D32006",
"value": "Cand:Unreviewed"
},
"id": 5,
"lastname": "Smith",
"middlename": "",
"phones": [
{
"entry": 1,
"phoneextension": "233",
"phonenumber": "212-555-5555",
"phonetype": {
"formattedvalue": "Home",
"id": "D84002",
"value": "Home"
}
}
],
"updateddate": "2026-03-02 10:41 AM"
}
}