Skip to main content

Intelliscreen Public API

The Intelliscreen Public API provides programmatic access to your organization's assessment data, allowing you to retrieve candidate information, assessment results, and manage the evaluation process through RESTful endpoints.

API Usage​

This API enables you to access and manage:

  • Assessment Data: Retrieve comprehensive information about assessments, including test results, scores, and candidate performance metrics
  • Candidate Information: Access candidate profiles, resumes, skills analysis, and assessment history
  • Position Management: Upload resumes, invite candidates, and track their progress through the assessment pipeline

Available Endpoints​

The API is organized into three main categories:

Candidates​

  • Get all candidates in your organization
  • Retrieve detailed candidate profiles and resume information
  • Access candidate assessment history and status
  • Search candidates by email address

Positions​

  • Retrieve position information with associated candidates
  • Upload candidate resumes to specific positions
  • Invite candidates to assessments via email
  • Update candidate status throughout the hiring process
  • Get AI-powered resume scoring and analysis

Assessment Results​

  • Access comprehensive test results and scores
  • Retrieve detailed question-level performance data
  • Download video recordings and transcriptions
  • Get AI-generated candidate evaluations and insights

Authentication​

All API requests require authentication using an API key. You'll need to obtain an API key from your Intelliscreen account and include it in your request headers.

To get started with authentication and API key management, see API Key Management.

Base URL​

https://api.intelliscreen.io

All endpoints are accessed relative to this base URL using standard HTTP methods (GET, POST, PUT).