Top

Peoplekeys API Changelog

This changelog covers what's changed in Peoplekeys's APIs.

The most recent version of the API is Version X, which was introduced on Date, 2015

Note that this changelog only reflects backwards-incompatible updates, so make sure you’re subscribed to our API updates mailing list to keep up with new features that don’t happen to break existing code.

Versions:

Version Path Date Introduced Available Until
v1.0 /app/api/ Date, 2015

Date, 2015

This is Peoplekey's first API launched on our new App 3 platform. API versions are supported for 90 days after the next version is released.

Changes

2015-02-27

ADDED

Client Side Assessments

We have expanded our API and added a litany of new client side assessment methods. These Methods will allow you to use our assessments directly on your website without the use of an iframe.

Error Handling

We have updated our error handling and included more descriptive text in the error message field.

2015-02-18

DEPRECATED

/app/api/assessment/:assessment_id/

[The method is DEPRECATED. Current version of API rejects requests to delete the assessment]

Method Delete
Description Deletes the assessment.
Route /app/api/assessment/:assessment_id/


/app/api/assessment/results/:account_id[?filterBy=:filterBy]

[The method is DEPRECATED. Use new /app/api/assessment/results/:account_id?extended[&email=:email] [&max_records=:max_records][&start_record=:start_record][&date_since=:date_since] instead]

Method GET
Description Returns information about assessment results available for the API caller account or one of its subaccounts. Result status records are sorted by assessment start timestamp, the latest record is first.
Route /app/api/assessment/results/:account_id[?filterBy=:filterBy]

NEW VERSION:

/app/api/assessment/results/:account_id?extended[&email=:email] [&max_records=:max_records][&start_record=:start_record][&date_since=:date_since]



/app/api/assessment/calculate/

[The method is DEPRECATED. Use new /app/api/assessment/results/calculate/:result_id instead]

Method POST
Description Obtains calculated raw scores for given assessment result.
Route /app/api/assessment/calculate/

NEW VERSION:

/app/api/assessment/results/calculate/:result_id



/app/api/assessment/:result_id/download

[The method is DEPRECATED. Use new GET /app/api/assessment/results/download/:result_id instead]

Method GET
Description Downloads full PDF report for given assessment result.
Route /app/api/assessment/:result_id/download

NEW VERSION:

GET /app/api/assessment/results/download/:result_id