Skip to main content
Documentation
Documentation
Peakon
Last Updated: 2025-10-17
Concept: Peakon API

Concept: Peakon API

Use the Peakon API to retrieve engagement data from Peakon. You can use the API as part of a custom integration or with an out-of-the-box connector (Example: the Workday Connector). Authenticate using an access token, then make GET requests to specific endpoints to access engagement scores and key metrics.

Authentication

Once you create a custom application, a unique access token is generated for that application. This token is secret and you must exchange it for an authorization token using the
/v1/auth/application
 endpoint.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \
--header 'Content-Type: application/json' \
--data-raw '{
"token": "
Add your token here
"
}'
A successful authentication request returns a JSON Web Token (JWT) authorization token. Use this token in all subsequent API requests. Although an application can have more than 1 authorization token, we enforce rate limits per application.
After authenticating with an access token to obtain a JWT, use it to make GET requests to endpoints to access engagement scores and other key metrics. API-based data retrieval is often part of a custom connector, which you can develop to interface directly with Peakon’s APIs.
Visit Steps: Build Custom Apps with REST API for more information on setup instructions.

Filtering

In addition to contextual routes, Workday Peakon supports additional filtering for many routes through the
filter
 query parameter. If a route supports filtering, the documentation lists it it as a
query
 parameter in the route specification. Filters are organized based on their logical model. To filter by the question driver, you prefix the filter with
question
. Example:
GET /v1/engagement/drivers?filter[question.driver]=autonomy
You can use multiple operators to match specific fields. Example: To get scores for only the autonomy and reward drivers:
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
For a list of supported filtering operators, visit Reference: Peakon API Filtering Values.

JSON Format

Workday Peakon renders all objects using JSON API, which is a method for modeling an object graph using JSON.

Routing

You can restrict some API requests to a specific company segment. You can also analyze the engagement data for all direct reports of a manager, or the eNPS of a specific department.
Example: To retrieve the engagement overview for the Sales Department (segment ID 149):
GET /v1/engagement/context/149/overview
To obtain the segment ID, use the context switcher to change the context from the Company to the segment itself. The context switcher is located on the top left corner of the page. Search the segment's name and select it to access it. The segment id appears in the URL after the
segment/
 parameter. For more information on the context switcher, visit Concept: Dashboard Contexts.

Rate Limiting

Workday Peakon is a multi-tenant service, and rate limits ensure fair usage across customers. Each registered application is subject to these default limits:
  • Up to 5000 requests per hour.
  • Up to 12 minutes of processing time per 5 minutes of wall clock time.
If your application exceeds either limit, the API will return a
429 Too Many Requests
 response. The default rate limits are periodically reviewed and updated.