Genesys

Genesys Gamification API

Gamification, Scorecard, and leaderboard

GitHub OpenAPI
Business capability
Talent Management BC-300.20

Operations 78

POST /api/v2/gamification/contests/uploads/prizeimages Generates pre-signed URL to upload a prize image for gamification contests #
POST /api/v2/employeeperformance/externalmetrics/data Write External Metric Data #
GET /api/v2/employeeperformance/externalmetrics/definitions/{metricId} Get an External Metric Definition #
DELETE /api/v2/employeeperformance/externalmetrics/definitions/{metricId} Delete an External Metric Definition #
PATCH /api/v2/employeeperformance/externalmetrics/definitions/{metricId} Update External Metric Definition #
GET /api/v2/employeeperformance/externalmetrics/definitions Get a list of External Metric Definitions of an organization, sorted by name in… #
POST /api/v2/employeeperformance/externalmetrics/definitions Create External Metric Definition #
GET /api/v2/gamification/status Gamification activation status #
PUT /api/v2/gamification/status Update gamification activation status #
GET /api/v2/gamification/leaderboard Leaderboard of the requesting user's division or performance profile #
GET /api/v2/gamification/leaderboard/bestpoints Best Points of the requesting user's current performance profile or division #
GET /api/v2/gamification/leaderboard/all Leaderboard by filter type #
GET /api/v2/gamification/leaderboard/all/bestpoints Best Points by division or performance profile #
GET /api/v2/gamification/metricdefinitions/{metricDefinitionId} Metric definition by id #
GET /api/v2/gamification/metricdefinitions All metric definitions #
GET /api/v2/gamification/templates/{templateId} Objective template by id #
GET /api/v2/gamification/templates All objective templates #
POST /api/v2/gamification/profiles/users/{userId}/query Query performance profiles in date range for a user #
POST /api/v2/gamification/profiles/users/me/query Query performance profiles in date range for the current user #
GET /api/v2/gamification/profiles/{profileId} Performance profile by id #
PUT /api/v2/gamification/profiles/{profileId} Updates a performance profile #
POST /api/v2/gamification/profiles/{profileId}/activate Activate a performance profile #
POST /api/v2/gamification/profiles/{profileId}/deactivate Deactivate a performance profile #
GET /api/v2/gamification/profiles/users/me Performance profile of the requesting user #
GET /api/v2/gamification/profiles/users/{userId} Performance profile of a user #
GET /api/v2/gamification/profiles All performance profiles #
POST /api/v2/gamification/profiles Create a new custom performance profile #
GET /api/v2/gamification/profiles/{profileId}/metrics/{metricId} Performance profile gamified metric by id #
PUT /api/v2/gamification/profiles/{profileId}/metrics/{metricId} Updates a metric in performance profile #
GET /api/v2/gamification/profiles/{profileId}/metrics/objectivedetails All metrics for a given performance profile with objective details such as… #
GET /api/v2/gamification/profiles/{profileId}/metrics All gamified metrics for a given performance profile #
POST /api/v2/gamification/profiles/{profileId}/metrics Creates a gamified metric with a given metric definition and metric objective… #
GET /api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId} Get a Contest Prize Image by Id #
GET /api/v2/gamification/contests Get a List of Contests (Admin) #
POST /api/v2/gamification/contests Creates a Contest #
GET /api/v2/gamification/contests/me Get a List of Contests (Agent/Supervisor) #
GET /api/v2/gamification/contests/{contestId} Get a Contest by Id #
PUT /api/v2/gamification/contests/{contestId} Update a Contest by Id #
DELETE /api/v2/gamification/contests/{contestId} Delete a Contest by Id #
PATCH /api/v2/gamification/contests/{contestId} Finalize a Contest by Id #
GET /api/v2/gamification/contests/{contestId}/agents/scores Get Contest Scores (Admin) #
GET /api/v2/gamification/contests/{contestId}/agents/scores/me Get Contest Scores for the requesting Agent/Supervisor #
GET /api/v2/gamification/contests/{contestId}/agents/scores/trends/me Get a Contest Score Trend for the requesting Agent #
GET /api/v2/gamification/contests/{contestId}/agents/scores/trends Get a Contest Score Trend (Average Trend) #
GET /api/v2/gamification/insights/users/{userId}/details Get insights details for the user #
GET /api/v2/gamification/insights/details Get insights details for the current user #
GET /api/v2/gamification/insights/members Query users in a profile during a period of time #
GET /api/v2/gamification/insights/managers Query managers in a profile during a period of time #
GET /api/v2/gamification/insights/groups/trends/all Get insights overall trend #
GET /api/v2/gamification/insights/groups/trends Get insights overall trend for the current user #
GET /api/v2/gamification/insights Get insights summary #
GET /api/v2/gamification/insights/rankings Get insights rankings #
GET /api/v2/gamification/insights/trends Get insights user trend for the current user #
GET /api/v2/gamification/insights/users/{userId}/trends Get insights user trend for the user #
GET /api/v2/gamification/profiles/{profileId}/members Members of a given performance profile #
POST /api/v2/gamification/profiles/{profileId}/members Assign members to a given performance profile #
POST /api/v2/gamification/profiles/{profileId}/members/validate Validate member assignment #
GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends Average performance values trends by metric of a division or a performance… #
GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends Average performance values trends by metric of a user #
GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends Average performance values trends by metric of the requesting user #
GET /api/v2/gamification/scorecards/bestpoints Best points of the requesting user #
GET /api/v2/gamification/scorecards Workday performance metrics of the requesting user #
GET /api/v2/gamification/scorecards/attendance Attendance status metrics of the requesting user #
GET /api/v2/gamification/scorecards/points/alltime All-time points of the requesting user #
GET /api/v2/gamification/scorecards/points/average Average points of the requesting user's division or performance profile #
GET /api/v2/gamification/scorecards/points/trends Points trends of the requesting user #
GET /api/v2/gamification/scorecards/values/trends Values trends of the requesting user or group #
GET /api/v2/gamification/scorecards/values/average Average values of the requesting user's division or performance profile #
GET /api/v2/gamification/scorecards/users/{userId} Workday performance metrics for a user #
GET /api/v2/gamification/scorecards/users/{userId}/bestpoints Best points of a user #
GET /api/v2/gamification/scorecards/users/{userId}/attendance Attendance status metrics for a user #
GET /api/v2/gamification/scorecards/users/{userId}/points/trends Points trend for a user #
GET /api/v2/gamification/scorecards/users/{userId}/points/alltime All-time points for a user #
GET /api/v2/gamification/scorecards/users/{userId}/values/trends Values trends of a user #
GET /api/v2/gamification/scorecards/users/points/average Workday average points by target group #
GET /api/v2/gamification/scorecards/users/values/average Workday average values by target group #
GET /api/v2/gamification/scorecards/users/values/trends Values trend by target group #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-gamification-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys-gamification-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-gamification-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Gamification API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (697 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-gamification-api-openapi.yml