Every Learning API endpoint, grouped by what it works on. Organization- and event-level endpoints sit side by side, with the scope each one needs.
Courses
| Endpoint | Level | Needs |
|---|
GET List videos a course can be made from/v1/organization/{orgId}/learning/media | Organization | read:learning |
GET List lessons and courses/v1/organization/{orgId}/learning/library | Organization | read:learning |
GET List course drafts/v1/organization/{orgId}/learning/drafts | Organization | read:learning |
POST Draft a course from videos/v1/organization/{orgId}/learning/drafts/create | Organization | write:learning |
GET Get a course draft/v1/organization/{orgId}/learning/drafts/{draftId} | Organization | read:learning |
PUT Save edits to a course draft/v1/organization/{orgId}/learning/drafts/{draftId} | Organization | write:learning |
POST Publish and assign a course draft/v1/organization/{orgId}/learning/drafts/{draftId}/apply | Organization | write:learning |
POST Assign a certification, course or lesson/v1/organization/{orgId}/learning/assignments/create | Organization | write:learning |
GET List certifications/v1/organization/{orgId}/learning/certifications | Organization | read:learning |
Learning workspace
| Endpoint | Level | Needs |
|---|
GET Get the Learning workspace home/v1/organization/{orgId}/learning/workspace | Organization | read:learning |
GET List courses and course drafts/v1/organization/{orgId}/learning/workspace/courses | Organization | read:learning |
GET Get a course and its learners/v1/organization/{orgId}/learning/workspace/courses/{lessonId} | Organization | read:learning |
GET Read a course's public page/v1/organization/{orgId}/learning/workspace/courses/{lessonId}/page | Organization | read:learning |
PUT Set a course's description/v1/organization/{orgId}/learning/workspace/courses/{lessonId}/page | Organization | write:learning |
POST Publish a course/v1/organization/{orgId}/learning/workspace/courses/{lessonId}/publish | Organization | write:learning |
POST Publish a reviewed course draft/v1/organization/{orgId}/learning/workspace/drafts/{draftId}/publish | Organization | write:learning |
GET Find a learner/v1/organization/{orgId}/learning/workspace/learners | Organization | read:learning |
GET Get a learner/v1/organization/{orgId}/learning/workspace/learners/{personId} | Organization | read:learning |
GET Get the credits overview/v1/organization/{orgId}/learning/workspace/credits | Organization | read:learning |
GET Get Learning results/v1/organization/{orgId}/learning/workspace/results | Organization | read:learning |
PUT Require watching before completion/v1/organization/{orgId}/learning/workspace/courses/{lessonId}/completion-watch | Organization | write:learning |
On demand and meetings
| Endpoint | Level | Needs |
|---|
GET List meetings that can go on demand/v1/organization/{orgId}/learning/workspace/on-demand | Organization | read:learning |
GET Preview a meeting on demand/v1/organization/{orgId}/learning/workspace/on-demand/{eventId} | Organization | read:learning |
POST Make draft courses from a meeting/v1/organization/{orgId}/learning/workspace/on-demand/{eventId} | Organization | write:learning |
POST Publish a meeting on demand/v1/organization/{orgId}/learning/workspace/on-demand/{eventId}/publish | Organization | write:learning |
GET List registration platforms a meeting can come from/v1/organization/{orgId}/learning/workspace/meetings/sources | Organization | read:learning |
GET List a registration platform's events/v1/organization/{orgId}/learning/workspace/meetings/sources/{appId}/events | Organization | read:learning |
POST Bring in a meeting from a registration platform/v1/organization/{orgId}/learning/workspace/meetings/import | Organization | write:learning |
POST Bring in a meeting and draft courses, step by step/v1/organization/{orgId}/learning/workspace/meetings/import-for-learning | Organization | write:learning |
GET Get an imported meeting/v1/organization/{orgId}/learning/workspace/meetings/{eventId} | Organization | read:learning |
Engagement
| Endpoint | Level | Needs |
|---|
GET Rank learners by engagement/v1/organization/{orgId}/learning/workspace/engagement/learners | Organization | read:learning |
GET Get one learner's engagement/v1/organization/{orgId}/learning/workspace/engagement/learners/{personId} | Organization | read:learning |
GET Get engagement scores for people/v1/organization/{orgId}/learning/workspace/engagement/scores | Organization | read:learning |
GET List learners to nudge/v1/organization/{orgId}/learning/workspace/engagement/nudge | Organization | read:learning |
GET Get Learning engagement results/v1/organization/{orgId}/learning/workspace/engagement/results | Organization | read:learning |
GET List people due for recertification/v1/organization/{orgId}/learning/workspace/engagement/recertification | Organization | read:learning |
GET Recommend courses/v1/organization/{orgId}/learning/workspace/engagement/recommend | Organization | read:learning |
GET Get Learning's signal sources/v1/organization/{orgId}/learning/workspace/engagement/sources | Organization | read:learning |
POST Bring Learning activity into engagement now/v1/organization/{orgId}/learning/workspace/engagement/sync | Organization | write:learning |
Question bank
| Endpoint | Level | Needs |
|---|
GET List the question bank/v1/organization/{orgId}/learning/workspace/question-bank | Organization | read:learning |
GET List the question bank's tags/v1/organization/{orgId}/learning/workspace/question-bank/tags | Organization | read:learning |
POST Add, edit, archive or restore a bank question/v1/organization/{orgId}/learning/workspace/question-bank/manage | Organization | write:learning |
POST Import questions from GIFT, Aiken or CSV/v1/organization/{orgId}/learning/workspace/question-bank/import | Organization | write:learning |
Course packages
| Endpoint | Level | Needs |
|---|
POST Get an upload URL for a course package/v1/organization/{orgId}/learning/workspace/packages/presign | Organization | write:learning |
POST Add a course package/v1/organization/{orgId}/learning/workspace/packages | Organization | write:learning |
GET List course packages/v1/organization/{orgId}/learning/workspace/packages | Organization | read:learning |
GET Get a course package/v1/organization/{orgId}/learning/workspace/packages/{packageId} | Organization | read:learning |
POST Rename, archive, restore or retry a course package/v1/organization/{orgId}/learning/workspace/packages/{packageId}/manage | Organization | write:learning |
Selling courses
| Endpoint | Level | Needs |
|---|
PUT Set a course's price and member price/v1/organization/{orgId}/learning/workspace/courses/{lessonId}/price | Organization | write:learning |
GET List coupons/v1/organization/{orgId}/learning/workspace/coupons | Organization | read:learning |
POST Create, change, stop or restore a coupon/v1/organization/{orgId}/learning/workspace/coupons/manage | Organization | write:learning |
GET List course sales/v1/organization/{orgId}/learning/workspace/sales | Organization | read:learning |
GET Read whether card payments are on/v1/organization/{orgId}/learning/workspace/payments | Organization | read:learning |
POST Remove a buyer's access/v1/organization/{orgId}/learning/workspace/sales/{orderId}/remove-access | Organization | write:learning |
POST Refund a course order/v1/organization/{orgId}/learning/workspace/sales/{orderId}/refund | Organization | write:learning |
PUT Set a learner's member status and license/v1/organization/{orgId}/learning/workspace/learners/{personId}/profile | Organization | write:learning |
CE Broker reporting
| Endpoint | Level | Needs |
|---|
GET Read CE Broker reporting/v1/organization/{orgId}/learning/workspace/reporting/ce-broker | Organization | read:learning |
PUT Set up CE Broker reporting/v1/organization/{orgId}/learning/workspace/reporting/ce-broker | Organization | write:learning |
GET Export the CE Broker roster/v1/organization/{orgId}/learning/workspace/reporting/ce-broker/export | Organization | read:learning |
POST Send ready credit to CE Broker/v1/organization/{orgId}/learning/workspace/reporting/ce-broker/submit | Organization | write:learning |
Sites
| Endpoint | Level | Needs |
|---|
GET List Sites/v1/organization/{orgId}/sites | Organization | — |
POST Make a Site/v1/organization/{orgId}/sites/make | Organization | — |
GET Get a Site/v1/organization/{orgId}/sites/{siteId} | Organization | — |
PUT Edit a Site's draft/v1/organization/{orgId}/sites/{siteId}/draft | Organization | — |
GET See what Publish would change/v1/organization/{orgId}/sites/{siteId}/diff | Organization | — |
GET Preview a Site as a role on a device/v1/organization/{orgId}/sites/{siteId}/preview | Organization | — |
POST Publish a Site/v1/organization/{orgId}/sites/{siteId}/publish | Organization | — |
POST Discard a Site's draft/v1/organization/{orgId}/sites/{siteId}/draft/discard | Organization | — |
GET List a Site's versions/v1/organization/{orgId}/sites/{siteId}/versions | Organization | — |
POST Restore a version into the draft/v1/organization/{orgId}/sites/{siteId}/versions/{versionId}/restore | Organization | — |
