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

Genesys Learning API

Manage learning modules

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

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

This API exposes 37 operations across 28 paths, and defines 91 schemas. It is described by OpenAPI 2.0, at version v2.

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

37 operations 28 paths 91 schemas 2 DELETE14 GET4 PATCH14 POST3 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
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Learning 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 37

Across 28 paths, the API surfaces 37 operations — 2 DELETE, 14 GET, 4 PATCH, 14 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Learning 37

Manage learning modules

POST
/api/v2/learning/assessments/scoring
Score learning assessment for preview
postLearningAssessmentsScoring 1 param → 200400401403404408409413
POST
/api/v2/learning/assignments/aggregates/query
Retrieve aggregated assignment data
postLearningAssignmentsAggregatesQuery 1 param → 200400401403404408409413
GET
/api/v2/learning/assignments/{assignmentId}
Get Learning Assignment
getLearningAssignment 2 params → 200400401403404408409413
DELETE
/api/v2/learning/assignments/{assignmentId}
Delete a learning assignment
deleteLearningAssignment 1 param → 204400401403404408409413
PATCH
/api/v2/learning/assignments/{assignmentId}
Update Learning Assignment
patchLearningAssignment 2 params → 200400401403404408409413
GET
/api/v2/learning/assignments
List of Learning module Assignments
getLearningAssignments 15 params → 200400401403404408409413
POST
/api/v2/learning/assignments
Create Learning Assignment
postLearningAssignments 1 param → 200202400401403404408409
PATCH
/api/v2/learning/assignments/{assignmentId}/reschedule
Reschedule Learning Assignment
patchLearningAssignmentReschedule 2 params → 200202400401403404408409
GET
/api/v2/learning/assignments/me
List of Learning Assignments assigned to current user
getLearningAssignmentsMe 14 params → 200400401403404408409413
POST
/api/v2/learning/assignments/{assignmentId}/reset
Reset Learning Assignment
postLearningAssignmentReset 1 param → 200400401403404408409413
POST
/api/v2/learning/assignments/{assignmentId}/reassign
Reassign Learning Assignment
postLearningAssignmentReassign 1 param → 200202400401403404408409
POST
/api/v2/learning/assignments/bulkadd
Add multiple learning assignments
postLearningAssignmentsBulkadd 1 param → 200400401403404408409413
POST
/api/v2/learning/assignments/bulkremove
Remove multiple Learning Assignments
postLearningAssignmentsBulkremove 1 param → 200400401403404408409413
GET
/api/v2/learning/assignments/{assignmentId}/steps/{stepId}
Get Learning Assignment Step
getLearningAssignmentStep 5 params → 200400401403404408409413
PATCH
/api/v2/learning/assignments/{assignmentId}/steps/{stepId}
Update Learning Assignment Step
patchLearningAssignmentStep 3 params → 200400401403404408409413
POST
/api/v2/learning/rules/query
Get users for learning module rule
postLearningRulesQuery 3 params → 200400401403404408409413
GET
/api/v2/learning/modules/{moduleId}
Get a learning module
getLearningModule 2 params → 200400401403404408409413
PUT
/api/v2/learning/modules/{moduleId}
Update a learning module
putLearningModule 2 params → 200400401403404408409413
DELETE
/api/v2/learning/modules/{moduleId}
Delete a learning module
deleteLearningModule 1 param → 204400401403404408409413
GET
/api/v2/learning/modules/{moduleId}/preview
Get a learning module preview
getLearningModulePreview 1 param → 200400401403404408409413
PUT
/api/v2/learning/modules/{moduleId}/preview
Update a learning module preview
putLearningModulePreview 2 params → 200400401403404408409413
GET
/api/v2/learning/modules/{moduleId}/jobs/{jobId}
Get a specific Learning Module job status
getLearningModuleJob 2 params → 200400401403404408409413
GET
/api/v2/learning/modules/{moduleId}/versions/{versionId}
Get specific version of a published module
getLearningModuleVersion 3 params → 200400401403404408409413
GET
/api/v2/learning/modules/coverart/{coverArtId}
Get a specific Learning Module cover art using ID
getLearningModulesCoverartCoverArtId 1 param → 200400401403404408409413
GET
/api/v2/learning/modules
Get all learning modules of an organization
getLearningModules 9 params → 200400401403404408409413
POST
/api/v2/learning/modules
Create a new learning module
postLearningModules 1 param → 200400401403404408409413
POST
/api/v2/learning/modules/{moduleId}/publish
Publish a Learning module
postLearningModulePublish 2 params → 200400401403404408409413
POST
/api/v2/learning/modules/{moduleId}/jobs
Starts a specified operation on learning module
postLearningModuleJobs 2 params → 202400401403404408409413
GET
/api/v2/learning/modules/assignments
Get all learning modules of an organization including assignments for a specific user
getLearningModulesAssignments 7 params → 200400401403404408409413
PATCH
/api/v2/learning/modules/{moduleId}/users/{userId}/assignments
Update an external assignment for a specific user
patchLearningModuleUserAssignments 3 params → 200400401403404408409413
GET
/api/v2/learning/modules/{moduleId}/rule
Get a learning module rule
getLearningModuleRule 1 param → 200400401403404408409413
PUT
/api/v2/learning/modules/{moduleId}/rule
Update a learning module rule
putLearningModuleRule 3 params → 200400401403404408409413
POST
/api/v2/learning/scheduleslots/jobs
Start job to retrieve slots where a learning activity can be scheduled.
postLearningScheduleslotsJobs 1 param → 202400401403404408409413
GET
/api/v2/learning/scheduleslots/jobs/{jobId}
Retrieve the status of the job for the slots where a learning activity can be scheduled.
getLearningScheduleslotsJob 1 param → 200400401403404408409413
POST
/api/v2/learning/scheduleslots/query
Get list of possible slots where a learning activity can be scheduled.
postLearningScheduleslotsQuery 1 param → 200400401403404408409413
GET
/api/v2/learning/scorm/{scormId}
Get Learning SCORM Result
getLearningScormScormId 1 param → 200400401403404408409413
POST
/api/v2/learning/scorm
Create a SCORM package upload request
postLearningScorm 1 param → 201400401403404408409413

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are AssignedLearningModule (28 properties), LearningModule (27 properties), LearningAssignment (25 properties), AssessmentQuestionGroupScore (16 properties). Each schema is shown below with its type and property counts.

ReviewAssessmentResults
object
2 properties
LearningSlotFullDayTimeOffMarker
object
6 properties
LearningScormUploadRequest
object
Learning SCORM upload request
1 property 1 required
LearningModuleRule
object
4 properties 2 required
LearningCoverArtThumbnail
object
2 properties
DisallowedEntityLearningAssignmentReference
object
2 properties
LearningModuleAutoAssignRequest
object
Auto assign request
2 properties 2 required
LearningAssignmentAggregateQueryResponseData
object
2 properties
LearningAssignmentStepScoStructure
object
5 properties
LearningModulePreviewGetResponse
object
Learning module preview get response
9 properties 1 required
LearningModuleAutoAssignResponse
object
Auto assign response
2 properties 2 required
LearningModulePreviewUpdateStep
object
Learning module preview update assignment step
6 properties
LearningAssignmentBulkRemoveResponse
object
2 properties
LearningAssignmentUser
object
3 properties
LearningAssessment
object
8 properties
LearningModulePreviewUpdateResponseAssignment
object
Learning module preview update response assignment
8 properties
LearningModulePreviewUpdateRequest
object
Learning module preview update request
5 properties
LearningScheduleSlotsQueryResponse
object
2 properties
LearningAssessmentScoringRequest
object
2 properties 2 required
LearningAssignmentCreate
object
5 properties 2 required
LearningModuleCoverArtRequest
object
1 property 1 required
LearningScormResponse
object
Learning SCORM package
6 properties
LearningScheduleSlotsQueryRequest
object
4 properties 3 required
LearningModulePreviewGetResponseAssignment
object
Learning module preview get response assignment
7 properties
LearningAssignmentAggregateResponse
object
1 property
LearningAssignmentReschedule
object
3 properties 1 required
LearningAssignmentUserListing
object
List of users matching the learning module rule
11 properties
LearningAssignmentExternalUpdate
object
3 properties
LearningModuleRequest
object
Learning module request
13 properties 2 required
LearningModuleJobResponse
object
Learning module job response
3 properties
LearningModulePreviewGetResponseStep
object
Learning module preview get response assignment step
8 properties
AssessmentForm
object
7 properties 2 required
LearningAssignmentStep
object
Learning assignment step
10 properties
AnswerOption
object
6 properties
LearningSlot
object
4 properties
LearningModulePreviewUpdateScoStructure
object
Learning module preview update SCO structure
6 properties
DisallowedEntityLearningAssignmentItem
object
2 properties
LearningModuleSummary
object
Learning module summary data
4 properties
LearningModuleInformStep
object
8 properties 3 required
UsersRulesRuleReference
object
2 properties
LearningShareableContentObject
object
Learning assignment SCO (Shareable Content Object)
16 properties 1 required
AssignedLearningModule
object
Learning module response
28 properties 2 required
LearningModulePublishRequest
object
Learning module publish request
1 property
LearningModuleInformStepRequest
object
Learning module inform steps request
8 properties 3 required
LearningSlotScheduleActivity
object
8 properties
LearningAssignmentAggregateQueryResponseGroupedData
object
2 properties
LearningAssignmentsDomainEntity
object
10 properties
AssessmentFormQuestion
object
12 properties 1 required
Detail
object
4 properties
LearningScheduleSlotsJobRequest
object
5 properties 5 required
LearningSlotWfmScheduleActivity
object
3 properties
LearningAssignmentReference
object
2 properties
LearningAssignmentAggregateQueryResponseMetric
object
2 properties
LearningAssignmentUpdate
object
2 properties
LearningModulePreviewUpdateResponseCurrentStep
object
Learning module preview update response current step
1 property
AssessmentQuestionGroupScore
object
16 properties 1 required
LearningModuleRuleParts
object
4 properties 4 required
LearningModulePreviewUpdateRequestCurrentStep
object
Learning module preview update request current step
3 properties
LearningScheduleSlotsJobResponse
object
8 properties
LearningModuleCoverArtResponse
object
Learning module cover art response
4 properties
LearningModuleReassignSummary
object
Learning module reassign summary data
5 properties
LearningModuleJobRequest
object
Learning module job request
1 property 1 required
Limit
object
3 properties
LearningAssignmentStepSignedCookie
object
2 properties
LearningModulePublishResponse
object
Learning module publish response
3 properties
AssessmentQuestionScore
object
8 properties 1 required
AssessmentFormQuestionGroup
object
12 properties 3 required
LearningAssignmentItem
object
2 properties 2 required
LearningAssignmentUserQuery
object
Learning module users query request model
2 properties 1 required
LearningAssignmentAggregateQueryRequestPredicate
object
2 properties 2 required
AssignedLearningModuleDomainEntityListing
object
10 properties
UserReference
object
2 properties
LearningScheduleSlotsJobResult
object
3 properties
LearningAssignmentBulkAddResponse
object
2 properties
AssistanceCondition
object
2 properties
LearningModuleList
object
Learning module list
11 properties
LearningAssignmentAggregateQueryResponseStats
object
4 properties
LearningScheduleSlotsJobSchedule
object
4 properties
LearningModulePreviewUpdateResponse
object
Learning module preview update response
2 properties
ErrorBody
object
11 properties
VisibilityCondition
object
2 properties
LearningAssignmentEntity
object
1 property
LearningAssignmentAggregateQueryRequestFilter
object
2 properties 2 required
LearningScheduleSlotsJobSlot
object
2 properties
LearningModulePreviewGetScoStructure
object
Learning module preview get SCO structure
7 properties
AssessmentScoringSet
object
8 properties 1 required
LearningModule
object
Learning module response
27 properties 2 required
LearningAssignment
object
Learning module assignment with user information
25 properties
LearningScormUploadResponse
object
Learning SCORM upload response
5 properties
LearningAssignmentAggregateQueryRequestClause
object
2 properties 2 required
LearningAssignmentAggregateParam
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-learning-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

This is an independent, third-party profile of Genesys Learning 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.