• 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

Customers

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"
}

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