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
  • Schemas
    • Get schemaget
  • Users
    • Get usersget
    • Create userpost
    • Get userget
    • Update userput
    • Delete userdel
    • Patch userpatch
Powered by 

Rate Limiting

The Peakon SCIM API is rate limited at 25,000 operations/hour. A bulk SCIM API request consumes 1 operation per operation in the request payload. Other SCIM API requests consume 1 operation.

Any integration should throttle its API calls to make sure this limit is not exceeded.