• 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

REST API

iCIMS supports RESTful web service integrations using JSON.  A combination of the dominant web API design model (REST) and a standard human-readable data exchange (JSON) allows iCIMS and our partners to create repeatable and scalable integrations. Web services offer several advantages over simple data imports and exports, making them iCIMS preferred integration method.

Licenses

Read about iCIMS Web services integration licensing, including the number of requests allowed per day, per license.

Learn More
Connecting, Authenticating, and Identity

Review information about iCIMS connectivity, including guidelines, the HTTP transport policy, IP address restrictions, and rate limits, as well as authentication and error handling.

Learn More
HMAC

Learn about authenticating with HMAC.

Learn More
Error Handling

Review information about iCIMS Error Reporting Standard, which is available for vendors who wish to respond to an iCIMS request with error information.

Learn More
Error Reporting Standard for Vendors

In the event that a 3rd party vendor wishes to respond to an iCIMS request with error information, iCIMS has defined an Error Reporting Standard.

Learn More
Field Types

Learn more about the different field types available and their representation when retrieving their values, as well as the expected representations when modifying them.

Learn More
Authenticating API Calls with OAuth 2.0

Review infomation about iCIMS API authentication using OAuth 2.0.

Learn More
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