The Predictive Index

The Predictive Index Candidates API

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

Documentation GitHub OpenAPI

Business capability

Talent Acquisition Management BC-300.10

Operations 4

GET /api/v1/candidates/ Search for an existing candidate #

POST /api/v1/candidates/ Create a candidate and send an assessment #

PATCH /api/v1/candidates/{personId} Update an existing candidate (e.g. assign new job) #

GET /api/v1/candidates/{personId}/insightspacket Generate a Candidate Insights package #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/the-predictive-index:the-predictive-index-candidates-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Predictive Index Integration Candidates API
  version: v1
  description: RESTful Integration API for The Predictive Index talent optimization platform.
  x-provenance:
    method: searched
    source: https://developers.predictiveindex.com/integration-examples
    generated: '2026-07-21'
servers:
- url: https://integrations.predictiveindex.com
  description: Production
security:
- apiKeyAuth: []
tags:
- name: Candidates
paths:
  /api/v1/candidates/:
    get:
      operationId: listCandidates
      summary: Search for an existing candidate
      tags:
      - Candidates
      responses:
        '200':
          description: Candidate list
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      operationId: createCandidate
      summary: Create a candidate and send an assessment
      description: Single entry point for all assessment-sending workflows. Handles candidate creation or updating, job assignment, and assessment delivery in one request. Returns an isExistingCandidate property indicating whether a new candidate record was created.
      tags:
      - Candidates
      responses:
        '200':
          description: Candidate created or updated and assessment sent
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
  /api/v1/candidates/{personId}:
    patch:
      operationId: updateCandidate
      summary: Update an existing candidate (e.g. assign new job)
      tags:
      - Candidates
      parameters:
      - name: personId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Candidate updated
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
  /api/v1/candidates/{personId}/insightspacket:
    get:
      operationId: getCandidateInsightsPacket
      summary: Generate a Candidate Insights package
      tags:
      - Candidates
      parameters:
      - name: personId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Candidate Insights packet
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Unauthorized:
      description: Authorization has been denied for this request. The api-key is missing, invalid, or was generated under a user lacking org-admin permissions or who has been disabled.
    RateLimited:
      description: Too many requests. Requests are subject to a rate specified in the X-RateLimit-Limit response header, measured over a 60-second period.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: '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. Format: api-key: YOUR_APIKEY_GOES_HERE'