• iCIMS Corporate Site
  • iCIMS Partners
  • Additional Resources
  • Recent Updates
  • FAQ
  • Login
  • GETTING STARTED
    • Getting Started
    • Integration Approval Process
    • How-To Videos
    • Acceptable Use Policy
    • Terms of Use
    • Release Notes
  • API
    • Licenses
    • Connecting, Authenticating, and Identity
    • Authenticating API Calls with OAuth 2.0
    • HMAC
    • Error Handling
    • Error Reporting Standard for Vendors
    • Field Types
  • Standard Integrations
    • Assessments
    • Candidate Matching
    • Candidate Ranking
    • Document Management
    • Data Analytics and Reporting
    • Human Capital Management
    • I-9 & E-Verify
    • Job Advertising
    • Job Posting
    • Partner Screening
    • Reference Checks
    • Tax Credits
    • Video Interviewing
  • Prime Integrations
    • Prime Assessments
    • Prime Background Screen
      • Implementation
  • Endpoints
    • Binary Collection Fields
    • Binary Files
    • Collection Fields
    • Customers
    • Direct Linking
    • iForms
    • Job Distributor
    • Job Portal API
    • List API
    • Offer API
    • Onboard API
    • Profiles
    • Schema API
    • Search API
    • Workflows
  • Streaming Endpoints
  • Data Models
    • iForms
    • Job
    • Location
    • New Hire Category
    • Onboarding Workflow
    • Person
    • Recruiting Workflow
    • Room
    • Sourcing Workflow
    • Talent Pool
    • Event
    • Validation
  • Integration Events
    • Best Practices
    • Application Complete
    • Job Edit
    • Job Posting
    • Job Unposting
    • Onboard Portal Task
    • Status Flow Update
  • OTHER TECH
    • File-Based Transfers
      • Scheduled Import/Export Licenses
      • Imports
      • Exports
      • File Formatting
      • Import File Examples
    • SAML
    • Standard XML Feed for Job Boards
  • Forum

Search form

Developer Resources
  • Getting Started
  • API
  • Standard Integrations
  • Prime Integrations
  • Endpoints
    • Binary Collection Fields
    • Binary Files
    • Collection Fields
    • Customers
    • Direct Linking
    • iForms
    • Job Distributor
    • Job Portal API
    • List API
    • Offer API
    • Onboard API
    • Profiles
    • Schema API
    • Search API
    • Workflows
    • Standard Apply Framework Questions
  • Streaming Endpoints
  • Data Models
  • Integration Events
  • OTHER TECHNOLOGY
  • FAQ

Collection Fields

Supported commands for Collection Fields are as follows.

Create a new collection field group

Collection field groups can be created for all profiles.

Notes:

  • "Content-Type: application/json" must be set for calls sending JSON payloads
  • The iCIMS system does not allow for duplicate collection entries. API calls that result in duplicate collection entries to be created or updated will return success without modifying the collection data.
URL: 

api.icims.com/customers/{customerId}/{profileType}/{profileID}/fields/{collectionFieldId}

Action
Definition
Post: 

api.icims.com/customers/1234/people/1289/fields/phones
Content-Type: application/json

{
  "phonetype": {
    "value": "Mobile"
  },
  "phonenumber":
 "666 222 2222"
}

 

Response: HTTP/1.1 201 Created
Location:“api.icims.com/customers/1234/people/1289/fields/phones/332"

Get the value of a specified field on a specific Profile

The value returned for the field will be the value returned in the JSON of the entire Profile. See the Field Types sections for details on what each field type returns. 

Note: The iCIMS system does not allow for duplicate collection entries. API calls that result in duplicate collection entries to be created or updated will return success without modifying the collection data.

 

URL: 

https://api.icims.com/customers/{customerId}/{profileType}/{profileID}/fields/{collectionFieldId}/{groupId}

{collectionFieldId}
The name of the collection field to retrieve. For example, for custom fields, the format is field and then a numeric internal identifier, such as field1234.
{groupId}
The numeric identifier of the collection group to retrieve. For example, for addresses, this could be a specific addressId.
Action
Definition
Get: 

https://api.icims.com/customers/1234/people/5/fields/addresses/35

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
   “addressstreet1”:“Apple St”,
   “addresscity”:“Hazlet”,
   “addresstype”{
      “entry”:“D1334”,
      “value”:“Home”
  }
    "primary" : true
}

Note: For JSON schema GET calls of collections (described here), the value for primary will look like:

"primary" : {
  "type" : "boolean"
}

 

Patch: 

https://api.icims.com/customers/1234/people/1289/fields/addresses/332
Content-Type: application/json

{
  “addressstreet1”:“Apple St”,
  “addresscity”:“Hazlet”,
  “addresstype”{
     “entry”:“D1334”,
     “value”:“Home”
 }
}

Delete: 

api.icims.com/customers/1234/people/1289/fields/phones/332 (no payload required)

Do you have any questions or feedback regarding iCIMS' API documentation? Email the team
See Recent Site Updates

© 2023 iCIMS, Inc. All rights reserved.
Privacy Notice | Terms of Use