Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Predictive Index Candidates API

The Candidates API from The Predictive Index — 3 operation(s) for candidates.

The Predictive Index Candidates API is one of 4 APIs that The Predictive Index publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Candidates. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 4 operations across 3 paths. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://integrations.predictiveindex.com.

4 operations 3 paths 0 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://integrations.predictiveindex.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

The Predictive Index Candidates API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key sent in the api-key request header. The key is generated under a user with org-admin permissions (with cognitive access enabled) in the PI Software. Fo…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Candidates 4
GET
/api/v1/candidates/
Search for an existing candidate
listCandidates → 200401429
POST
/api/v1/candidates/
Create a candidate and send an assessment
createCandidate → 200401429
PATCH
/api/v1/candidates/{personId}
Update an existing candidate (e.g. assign new job)
updateCandidate 1 param → 200401429
GET
/api/v1/candidates/{personId}/insightspacket
Generate a Candidate Insights package
getCandidateInsightsPacket 1 param → 200401429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-predictive-index-candidates-api-openapi.yml Raw ↑

Other APIs The Predictive Index publishes across the network.

The Predictive Index Behavioral Assessments API
The Predictive Index Employees API
The Predictive Index Jobs API