For AI agents: visit https://developer.peakon.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Peakon
HomeGuidesAPI Reference
v1.1.0

Peakon
API Reference
v1.1.0HomeGuidesAPI Reference

Overview

  • Using the Peakon API
    • Legacy and future API domains
    • Authentication
    • Filtering
    • JSON API
    • Routing
    • Rate Limiting
  • Using the SCIM 2.0 API
    • Schema Extensions
    • Rate Limiting

Peakon API

  • Actions
    • Get actionsget
  • Audits
    • Get auditsget
  • Authentication
    • Authenticate applicationpost
  • Employees
    • Get employeesget
    • Create employeepost
    • Get employees for contextget
    • Get employee countget
    • Get employee count for contextget
    • Get employeeget
    • Update employeepatch
    • Delete employeedel
  • Engagement
    • Get overviewget
    • Get overview for contextget
    • Get for driversget
    • Get for drivers for contextget
    • Get by driverget
    • Get by driver for contextget
    • Get segmentsget
    • Get segments groupsget
    • Get segments for attributeget
  • Scores
    • Get category scores by groupget
    • Get question scores by groupget
  • Segments
    • Get segmentsget
  • Answers
    • Get survey answersget

SCIM 2.0 API

  • ServiceProviderConfig
    • Get configget
  • Users
    • Get usersget
    • Create userpost
    • Get userget
    • Update userput
    • Delete userdel
    • Patch userpatch
  • Schemas
    • Get schemaget
Powered by 

JSON API

All objects are rendered using JSON API, a method of for modelling an object graph using JSON.

Updated 10 months ago


Filtering
Routing
Did this page help you?

Updated 10 months ago


Filtering
Routing
Did this page help you?