How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Gamification API

Gamification, Scorecard, and leaderboard

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Gamification API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gamification. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 78 operations across 65 paths, and defines 121 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

78 operations 65 paths 121 schemas 2 DELETE57 GET2 PATCH13 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Gamification API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 78

Across 65 paths, the API surfaces 78 operations — 2 DELETE, 57 GET, 2 PATCH, 13 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Gamification 78

Gamification, Scorecard, and leaderboard

POST
/api/v2/gamification/contests/uploads/prizeimages
Generates pre-signed URL to upload a prize image for gamification contests
postGamificationContestsUploadsPrizeimages 1 param → 200400401403404408409413
POST
/api/v2/employeeperformance/externalmetrics/data
Write External Metric Data
postEmployeeperformanceExternalmetricsData 1 param → 200400401403404408409413
GET
/api/v2/employeeperformance/externalmetrics/definitions/{metricId}
Get an External Metric Definition
getEmployeeperformanceExternalmetricsDefinition 1 param → 200400401403404408409413
DELETE
/api/v2/employeeperformance/externalmetrics/definitions/{metricId}
Delete an External Metric Definition
deleteEmployeeperformanceExternalmetricsDefinition 1 param → 204400401403404408409413
PATCH
/api/v2/employeeperformance/externalmetrics/definitions/{metricId}
Update External Metric Definition
patchEmployeeperformanceExternalmetricsDefinition 2 params → 200400401403404408409413
GET
/api/v2/employeeperformance/externalmetrics/definitions
Get a list of External Metric Definitions of an organization, sorted by name in ascending order
getEmployeeperformanceExternalmetricsDefinitions 2 params → 200400401403404408409413
POST
/api/v2/employeeperformance/externalmetrics/definitions
Create External Metric Definition
postEmployeeperformanceExternalmetricsDefinitions 1 param → 200201400401403404408409
GET
/api/v2/gamification/status
Gamification activation status
getGamificationStatus → 200400401403404408409413
PUT
/api/v2/gamification/status
Update gamification activation status
putGamificationStatus 1 param → 200400401403404408409413
GET
/api/v2/gamification/leaderboard
Leaderboard of the requesting user's division or performance profile
getGamificationLeaderboard 3 params → 200400401403404408409413
GET
/api/v2/gamification/leaderboard/bestpoints
Best Points of the requesting user's current performance profile or division
getGamificationLeaderboardBestpoints → 200400401403404408409413
GET
/api/v2/gamification/leaderboard/all
Leaderboard by filter type
getGamificationLeaderboardAll 5 params → 200400401403404408409413
GET
/api/v2/gamification/leaderboard/all/bestpoints
Best Points by division or performance profile
getGamificationLeaderboardAllBestpoints 2 params → 200400401403404408409413
GET
/api/v2/gamification/metricdefinitions/{metricDefinitionId}
Metric definition by id
getGamificationMetricdefinition 1 param → 200400401403404408409413
GET
/api/v2/gamification/metricdefinitions
All metric definitions
getGamificationMetricdefinitions → 200400401403404408409413
GET
/api/v2/gamification/templates/{templateId}
Objective template by id
getGamificationTemplate 1 param → 200400401403404408409413
GET
/api/v2/gamification/templates
All objective templates
getGamificationTemplates → 200400401403404408409413
POST
/api/v2/gamification/profiles/users/{userId}/query
Query performance profiles in date range for a user
postGamificationProfilesUserQuery 2 params → 200400401403404408409413
POST
/api/v2/gamification/profiles/users/me/query
Query performance profiles in date range for the current user
postGamificationProfilesUsersMeQuery 1 param → 200400401403404408409413
GET
/api/v2/gamification/profiles/{profileId}
Performance profile by id
getGamificationProfile 1 param → 200400401403404408409413
PUT
/api/v2/gamification/profiles/{profileId}
Updates a performance profile
putGamificationProfile 2 params → 200400401403404408409413
POST
/api/v2/gamification/profiles/{profileId}/activate
Activate a performance profile
postGamificationProfileActivate 1 param → 200400401403404408409413
POST
/api/v2/gamification/profiles/{profileId}/deactivate
Deactivate a performance profile
postGamificationProfileDeactivate 1 param → 200400401403404408409413
GET
/api/v2/gamification/profiles/users/me
Performance profile of the requesting user
getGamificationProfilesUsersMe 1 param → 200400401403404408409413
GET
/api/v2/gamification/profiles/users/{userId}
Performance profile of a user
getGamificationProfilesUser 2 params → 200400401403404408409413
GET
/api/v2/gamification/profiles
All performance profiles
getGamificationProfiles → 200400401403404408409413
POST
/api/v2/gamification/profiles
Create a new custom performance profile
postGamificationProfiles 2 params → 201400401403404408409413
POST
/api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link
Creates a linked metric
postGamificationProfileMetricLink 3 params → 201400401403404408409413
GET
/api/v2/gamification/profiles/{profileId}/metrics/{metricId}
Performance profile gamified metric by id
getGamificationProfileMetric 3 params → 200400401403404408409413
PUT
/api/v2/gamification/profiles/{profileId}/metrics/{metricId}
Updates a metric in performance profile
putGamificationProfileMetric 3 params → 200400401403404408409413
GET
/api/v2/gamification/profiles/{profileId}/metrics/objectivedetails
All metrics for a given performance profile with objective details such as order and maxPoints
getGamificationProfileMetricsObjectivedetails 2 params → 200400401403404408409413
GET
/api/v2/gamification/profiles/{profileId}/metrics
All gamified metrics for a given performance profile
getGamificationProfileMetrics 4 params → 200400401403404408409413
POST
/api/v2/gamification/profiles/{profileId}/metrics
Creates a gamified metric with a given metric definition and metric objective under in a performance profile
postGamificationProfileMetrics 2 params → 201400401403404408409413
GET
/api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}
Get a Contest Prize Image by Id
getGamificationContestPrizeimage 2 params → 200400401403404408409413
GET
/api/v2/gamification/contests
Get a List of Contests (Admin)
getGamificationContests 7 params → 200400401403404408409413
POST
/api/v2/gamification/contests
Creates a Contest
postGamificationContests 1 param → 200400401403404408409413
GET
/api/v2/gamification/contests/me
Get a List of Contests (Agent/Supervisor)
getGamificationContestsMe 8 params → 200400401403404408409413
GET
/api/v2/gamification/contests/{contestId}
Get a Contest by Id
getGamificationContest 1 param → 200400401403404408409413
PUT
/api/v2/gamification/contests/{contestId}
Update a Contest by Id
putGamificationContest 2 params → 200400401403404408409413
DELETE
/api/v2/gamification/contests/{contestId}
Delete a Contest by Id
deleteGamificationContest 1 param → 204400401403404408409413
PATCH
/api/v2/gamification/contests/{contestId}
Finalize a Contest by Id
patchGamificationContest 2 params → 200400401403404408409413
GET
/api/v2/gamification/contests/{contestId}/agents/scores
Get Contest Scores (Admin)
getGamificationContestAgentsScores 5 params → 200400401403404408409413
GET
/api/v2/gamification/contests/{contestId}/agents/scores/me
Get Contest Scores for the requesting Agent/Supervisor
getGamificationContestAgentsScoresMe 5 params → 200400401403404408409413
GET
/api/v2/gamification/contests/{contestId}/agents/scores/trends/me
Get a Contest Score Trend for the requesting Agent
getGamificationContestAgentsScoresTrendsMe 1 param → 200400401403404408409413
GET
/api/v2/gamification/contests/{contestId}/agents/scores/trends
Get a Contest Score Trend (Average Trend)
getGamificationContestAgentsScoresTrends 1 param → 200400401403404408409413
GET
/api/v2/gamification/insights/users/{userId}/details
Get insights details for the user
getGamificationInsightsUserDetails 6 params → 200400401403404408409413
GET
/api/v2/gamification/insights/details
Get insights details for the current user
getGamificationInsightsDetails 5 params → 200400401403404408409413
GET
/api/v2/gamification/insights/members
Query users in a profile during a period of time
getGamificationInsightsMembers 5 params → 200400401403404408409413
GET
/api/v2/gamification/insights/managers
Query managers in a profile during a period of time
getGamificationInsightsManagers 6 params → 200400401403404408409413
GET
/api/v2/gamification/insights/groups/trends/all
Get insights overall trend
getGamificationInsightsGroupsTrendsAll 7 params → 200400401403404408409413
GET
/api/v2/gamification/insights/groups/trends
Get insights overall trend for the current user
getGamificationInsightsGroupsTrends 7 params → 200400401403404408409413
GET
/api/v2/gamification/insights
Get insights summary
getGamificationInsights 12 params → 200400401403404408409413
GET
/api/v2/gamification/insights/rankings
Get insights rankings
getGamificationInsightsRankings 10 params → 200400401403404408409413
GET
/api/v2/gamification/insights/trends
Get insights user trend for the current user
getGamificationInsightsTrends 7 params → 200400401403404408409413
GET
/api/v2/gamification/insights/users/{userId}/trends
Get insights user trend for the user
getGamificationInsightsUserTrends 8 params → 200400401403404408409413
GET
/api/v2/gamification/profiles/{profileId}/members
Members of a given performance profile
getGamificationProfileMembers 1 param → 200400401403404408409413
POST
/api/v2/gamification/profiles/{profileId}/members
Assign members to a given performance profile
postGamificationProfileMembers 2 params → 200400401403404408409413
POST
/api/v2/gamification/profiles/{profileId}/members/validate
Validate member assignment
postGamificationProfileMembersValidate 2 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends
Average performance values trends by metric of a division or a performance profile
getGamificationScorecardsProfileMetricUsersValuesTrends 8 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends
Average performance values trends by metric of a user
getGamificationScorecardsProfileMetricUserValuesTrends 7 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends
Average performance values trends by metric of the requesting user
getGamificationScorecardsProfileMetricValuesTrends 7 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/bestpoints
Best points of the requesting user
getGamificationScorecardsBestpoints → 200400401403404408409413
GET
/api/v2/gamification/scorecards
Workday performance metrics of the requesting user
getGamificationScorecards 2 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/attendance
Attendance status metrics of the requesting user
getGamificationScorecardsAttendance 2 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/points/alltime
All-time points of the requesting user
getGamificationScorecardsPointsAlltime 1 param → 200400401403404408409413
GET
/api/v2/gamification/scorecards/points/average
Average points of the requesting user's division or performance profile
getGamificationScorecardsPointsAverage 1 param → 200400401403404408409413
GET
/api/v2/gamification/scorecards/points/trends
Points trends of the requesting user
getGamificationScorecardsPointsTrends 3 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/values/trends
Values trends of the requesting user or group
getGamificationScorecardsValuesTrends 5 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/values/average
Average values of the requesting user's division or performance profile
getGamificationScorecardsValuesAverage 2 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/{userId}
Workday performance metrics for a user
getGamificationScorecardsUser 3 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/{userId}/bestpoints
Best points of a user
getGamificationScorecardsUserBestpoints 1 param → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/{userId}/attendance
Attendance status metrics for a user
getGamificationScorecardsUserAttendance 3 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/{userId}/points/trends
Points trend for a user
getGamificationScorecardsUserPointsTrends 4 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/{userId}/points/alltime
All-time points for a user
getGamificationScorecardsUserPointsAlltime 2 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/{userId}/values/trends
Values trends of a user
getGamificationScorecardsUserValuesTrends 4 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/points/average
Workday average points by target group
getGamificationScorecardsUsersPointsAverage 3 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/values/average
Workday average values by target group
getGamificationScorecardsUsersValuesAverage 4 params → 200400401403404408409413
GET
/api/v2/gamification/scorecards/users/values/trends
Values trend by target group
getGamificationScorecardsUsersValuesTrends 5 params → 200400401403404408409413

Schemas 121

The contract defines 121 schemas that model the data the API accepts and returns. The most detailed are ContestsResponse (25 properties), Metrics (19 properties), ContestsCreateRequest (15 properties), ContestsEssentials (15 properties). Each schema is shown below with its type and property counts.

AddressableEntityRef
object
2 properties
MetricValueTrendAverage
object
9 properties
WorkdayPointsTrendItem
object
2 properties
WritableDivision
object
3 properties
CreateObjective
object
11 properties
OverallBestPointsItem
object
6 properties
InsightsDetails
object
8 properties
OverallBestPoints
object
3 properties
ContestScoreRanked
object
5 properties
UserInsightsTrendMetricItem
object
2 properties
UserProfilesInDateRange
object
4 properties
InsightsDetailsOverallPeriodPoints
object
6 properties
ContestScore
object
3 properties
ExternalMetricDataItem
object
7 properties 3 required
InsightsTrend
object
7 properties
WorkdayValuesTrendItem
object
2 properties
SingleWorkdayAverageValues
object
6 properties
UserBestPointsItem
object
5 properties
ExternalMetricDataUnprocessedItem
object
9 properties 3 required
PunctualityEvent
object
11 properties
InsightsTrendTotalItem
object
1 property
ContestScoresGroupTrend
object
3 properties
SingleWorkdayAveragePoints
object
4 properties
InsightsSummaryMetricItem
object
5 properties
AssignmentError
object
2 properties
WorkdayValuesTrend
object
9 properties
ObjectiveTemplate
object
4 properties
CreatePerformanceProfile
object
11 properties 6 required
ExternalMetricDefinitionListing
object
10 properties
CreateMetric
object
7 properties 1 required
InsightsAgentItem
object
4 properties
ContestMetricScore
object
4 properties
AttendanceStatusListing
object
1 property
ObjectiveZone
object
7 properties 5 required
GetContestsEssentialsListing
object
10 properties
ContestWinnersRequest
object
2 properties
ContestRequesingParticipantDailyInfo
object
2 properties
GamificationContestPrizeImageUploadUrlRequest
object
6 properties 2 required
UploadUrlResponse
object
3 properties
ExternalMetricDefinitionUpdateRequest
object
4 properties
ContestScoresAgentTrend
object
4 properties
InsightsDetailsOverallItem
object
3 properties
QualityEvaluationScoreItem
object
9 properties
GetMetricDefinitionsResponse
object
3 properties
InsightsAgents
object
6 properties
TargetPerformanceProfile
object
1 property 1 required
ProfileWithDateRange
object
6 properties
InsightsTrends
object
2 properties
ContestScoresAgents
object
4 properties
ContestsCreateRequest
object
15 properties 12 required
DomainEntityRef
object
3 properties
InsightsSummaryOverallPeriodPoints
object
4 properties
UserBestPoints
object
2 properties
PerformanceProfile
object
11 properties 3 required
MemberListing
object
1 property
InsightsDetailsMetricItem
object
5 properties
InsightsDetailsMetricPeriodPoints
object
7 properties
AssignUsers
object
2 properties 2 required
ContestScoresAgentsPagedList
object
6 properties
TrendData
object
4 properties
Detail
object
4 properties
UserTrendData
object
6 properties
GetTemplatesResponse
object
3 properties
ContestMetricScoreRanked
object
5 properties
AllTimePoints
object
3 properties
ContestScoresGroupTrendList
object
1 property
WorkdayPointsTrend
object
6 properties
Objective
object
11 properties
UserProfilesInDateRangeRequest
object
2 properties 2 required
InsightsRankings
object
7 properties
GetMetricsResponse
object
3 properties
Metrics
object
19 properties
Member
object
The associated user reference as a member of a performance profile
2 properties 1 required
Leaderboard
object
7 properties
WorkdayMetric
object
8 properties
ExternalMetricDefinitionCreateRequest
object
6 properties 5 required
ExternalMetricDataWriteResponse
object
External metric data write response
2 properties
Assignment
object
3 properties
ContestsFinalizeRequest
object
3 properties 1 required
ValidateAssignUsers
object
1 property 1 required
ContestProfile
object
3 properties 1 required
MetricDefinition
object
12 properties
Metric
object
13 properties 1 required
UserInsightsTrend
object
8 properties
Limit
object
3 properties
OtherProfileAssignment
object
3 properties
DefaultObjective
object
10 properties
ContestPrizes
object
6 properties 5 required
InvalidAssignment
object
2 properties
WorkdayValuesMetricItem
object
5 properties
UserInsightsTrendTotalItem
object
1 property
ContestMetrics
object
5 properties 3 required
ContestScoresAgentTrendList
object
2 properties
GetMetricResponse
object
3 properties
InsightsTrendMetricItem
object
2 properties
UserReference
object
2 properties
GamificationStatus
object
4 properties
WorkdayPeriod
object
2 properties
InsightsSummaryMetricPeriodPoints
object
5 properties
ContestUserRank
object
4 properties
WorkdayMetricListing
object
1 property
ErrorBody
object
11 properties
Division
object
3 properties
ExternalMetricDataWriteRequest
object
1 property 1 required
ExternalMetricDefinition
object
11 properties
InsightsSummaryUserItem
object
4 properties
ExternalMetricDataProcessedItem
object
9 properties 3 required
ContestsResponse
object
25 properties 10 required
ContestsEssentials
object
15 properties 5 required
ContestDisqualifiedAgents
object
3 properties
ContestWinners
object
3 properties
LeaderboardItem
object
3 properties
GetProfilesResponse
object
3 properties
InsightsSummaryOverallItem
object
3 properties
InsightsSummary
object
10 properties
DivisionReference
object
2 properties
AssignmentValidation
object
4 properties
ReportingInterval
object
2 properties 2 required
AttendanceStatus
object
3 properties
PrizeImages
object
1 property
UserInsightsTrends
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-gamification-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
#Gamification
← Back to G APIs
API Details
ID
genesys:genesys-gamification-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-gamification-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-gamification-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Genesys Gamification API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.