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 Employees API

The Employees API from The Predictive Index — 2 operation(s) for employees.

The Predictive Index Employees 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 Employees. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

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

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

2 operations 2 paths 0 schemas 2 GET

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 Employees 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 2

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

Employees 2
GET
/api/v1/employees/
Search for an existing employee
listEmployees → 200401429
GET
/api/v1/employees/reports/coachingguide
Generate a Coaching Guide PDF report for an employee
getEmployeeCoachingGuide → 200401429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs The Predictive Index publishes across the network.

The Predictive Index Behavioral Assessments API
The Predictive Index Candidates API
The Predictive Index Jobs API