API Guide

Note: This section is not intended to be a complete reference guide for all the API classes offered by The Predictive Index platform and detailed in the API Reference site. This section describes a few commonly used methods from one API class to provide a general sense of how all API classes and methods should be handled. Developers are expected to refer to the API Reference site and the other general articles here to understand the API as a whole.


The BehavioralAssessments API class provides access to Behavioral Assessments and the ability to create new assessment invitations. BehavioralAssessments represent the results of a scored Behavioral Assessment including the user who took the assessment and all of the related details associated with the assessment.

Supported HTTP Verbs

HTTP GET - Returns Behavioral Assessment details

HTTP POST - Creates a Behavioral Assessment

HTTP PATCH - Updates a Behavioral Assessment