Close Sidebar
Description

The Customer ID is a unique numeric identifier for each customer and ATS instance.

API Examples

Supported commands for the Customer object type are as follows.

URL: 

https://api.icims.com/customers/{CustomerID}

{Customer ID}

A unique string id that can be used to reference the Platform.

Action Definition
Get: Return a 200 response code; see example below.
Post: Not supported
Patch: Not supported
Delete: Not supported

Sample Response:

HTTP/1.1 200 OK

Strict-Transport-Security: max-age=7776000

X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
X-Customer-Type: test
Date: Mon, 01 Oct 2012 21:20:01 GMT
Content-Language: us

Content-Type: application/json;charset=UTF-8
Link: https://api.dev.icims.com/customers/449/jobs;rel="profiles";title="Available Job Profiles", https://api.dev.icims.com/customers/449/people;rel="profiles";title="Available Person Profiles", https://api.dev.icims.com/customers/449/companies;rel="profiles";title="Available Company Profiles", https://api.dev.icims.com/customers/449/performances;rel="profiles";title="Available Performances Profiles", https://api.dev.icims.com/customers/449/applicantworkflows;rel="profiles";title="Available Applicant Workflow Profiles", https://api.dev.icims.com/customers/449/performanceworkflows;rel="profiles";title="Available Performance Workflow Profiles", https://api.dev.icims.com/customers/449/forms;rel="forms";title="Available Forms

{
    "platformUrl": "customerXXX.icims.com",
    "id": 449,
    "customerType": "test",
    "name": "CustomerXXX",
    "buildVersion": "12.1"
}