☰ Close Sidebar
Description

Collection Fields are fields that can contain multiple records such as phones, and addresses on the person profile.

API Examples

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)