• 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

Data Models

Each client database includes multiple data models that can be found below. Each model includes a standard field framework that should be used for both retrieving and writing information from/to a client database. The Endpoints section contains information on how to use the Profiles API as well as the Search API.

Company

The Company Data Model is commonly used for integrations that need to pull Job or Person location (address) and hiring manager information from a job posting.

Learn More
iForms

The iForms Data Model is not currently used by any standard integrations.

Learn More
Job

The Job Profile Data Model is commonly used for several integrations, including Assessments, Background Checks, Tax Credits, and Video Interviewing.

Learn More
New Hire Category

View the New Hire Category data model.

Learn More
Onboarding Workflow

View the Onboarding Workflow data model.

Learn More
Person

The Person Profile Data Model is commonly used for several integrations, including I-9 & E-Verify, Assessments, Background Checks, Tax Credits, and Video Interviewing.

Learn More
Recruiting Workflow

The Recruiting Workflow is commonly used for integrations with Assessment and Tax Credit providers.

Learn More
Room

View the Room Profile data model.

Learn More
Sourcing Workflow

View the Sourcing Workflow data model.

Learn More
Talent Pool

View the Talent Pool Profile data model.

Learn More
Event

View the Event Profile data model.

Learn More
Validation

View information about Field Validation.

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