For AI agents: visit https://developers.workramp.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
WorkRamp API
API ReferenceChangelog
WorkRamp API
API Reference

Overview

  • Confirm Learn:Up & Academy API
  • Timestamps

Authentication & Headers

  • HTTP Bearer Token
  • Headers

Users & Groups

  • User Object
  • Get All Usersget
  • Create Userpost
  • Update Userpost
  • Delete Userdel
  • Get all Groupsget
  • Create Grouppost
  • Update Grouppost
  • Get All Users in a Groupget
  • Assign a User to a Grouppost
  • Get all User Assignmentsget

Custom User Attributes

  • Get All Users (Including Attributes)get
  • List a User's Custom Attributesget
  • Set Custom Attributes for a Userpost
  • Delete a Custom Attribute from a Userdel

Guides

  • Guide Object
  • Get All Guidesget

Guide Assignments

  • Assignment Object
  • Get All Guide Assignments in Date Rangeget
  • Get All Assignments/Guide (Deprecated)get
  • Create Assignmentpost
  • Update Assignmentpost
  • Delete Assignmentdel
  • Get All Unique Guide Assignment Changesget

Paths

  • Path Object
  • Get All Pathsget

Path Assignments

  • Assignment Object
  • Get All Assignments for a Pathget
  • Get All Path Assignments in Date Rangeget
  • Get Path Assignment by IDget
  • Create Path Assignmentpost
  • Update Path Assignmentpost
  • Delete Path Assignmentdel

Badges

  • Badge/Certification Object
  • Get All Certificationsget
  • Award Object
  • Get Awards by Certificationget
  • Get Awards by Userget

Events & Event Sessions

  • Get All Eventsget
  • Get Event Sessionget
  • Create Eventpost
  • Create Event Sessionpost
  • Invite Users to Event Sessionpost

Resources

  • Get All Resourcesget

SCIM (Private API)

  • SCIM: Get All Usersget
  • SCIM: Get Userget
  • SCIM: Create Userpost
  • SCIM: Update Userput
  • SCIM: Get All Groupsget
  • SCIM: Get Groupget
  • SCIM: Create Grouppost
  • SCIM: Patch Grouppatch
  • SCIM: Delete Groupdel

Libraries

  • Get All Librariesget
  • Get Libraryget
  • Search Public Libraryget
  • Search Within A Public Libraryget
  • Edit Librarypatch

Item Folders

  • Get All Item Foldersget
  • Create Item Folderpost
  • Edit Item Folderpatch
  • Delete Item Folderdel

SCORM

  • Get All SCORM Coursesget
  • Get All SCORM Assignments in Date Rangeget
  • Get All Assignments for a SCORM Courseget
  • Copy SCORMpost

SCORM Assignments

  • Update SCORM Assignmentpatch
  • Delete SCORM Assignmentdel
  • Bulk Create SCORM Assignmentspost
  • Bulk Delete SCORM Assignmentspost

Challenges

  • Get all Users for a Challengeget

Content Catalog

  • Get Content Catalogget

Webhook Subscriptions

  • Introduction to Webhooks
    • Challenge Assignment
    • Course/Guide Assignment
    • Path/Training Series Assignment
    • Resource Assignment
    • SCORM Assignment
    • Event Session Attendee
    • The User object
  • Get All Webhook Subscriptionsget
  • Get Webhook Subscriptionget
  • Create Webhook Subscriptionpost
  • Update Webhook Subscriptionpatch
  • Delete Webhook Subscriptiondel

White Label

  • White Label Customersget

Academies

  • Locate your Academy ID

Academy Contact (Learner) Management

  • Get All Contactsget
  • Get Contactget
  • Invite Contactspost
  • Create Contactpost
  • Update Contactpatch
  • Delete Contactdel
  • Add Contacts to Segmentpost
  • Remove Contacts from Segmentdel
  • Instant Authpost
  • Assign Segmentspost

Academy Learning Activity

  • What are Trainings, Registrations and Enrollments?
  • By Contact
    • Get All Registrations for a Contactget
    • Get all Paths for a Contactget
    • Get All Awarded Certifications For a Contactget
    • Get All Certifications for a Contactget
    • Assign Trainingspost
    • Assign Certificatespost
    • Assign Pathspost
    • Get Registration by Contact ID & Registration IDget
  • By Learning Object
    • Get All Registrations for a Trainingget
    • Get All Enrollments for a Certificationget
    • Get All Enrollments for a Pathget
  • Bulk Endpoints
    • Get All Registrationsget
    • Get All Awarded Certificationsget
    • Get All Completed Path Enrollmentsget
  • Delete Registration (Unassign)del
  • Deprecated Get All Registrations for a Contactget
  • Update Registration (Mark Complete)patch
  • Get Registration by IDget

Academy Content & Structure

  • What are Trainings?
  • Get All Trainingsget
  • Get Trainingget
  • Search for Trainingsget
  • Get All Offered Pathsget
  • Get All Offered Certificationsget
  • Get All Offered Collectionsget
  • Get Collectionget
  • Get Pathget
  • Get Certificationget
  • Get All Eventsget
  • Get Sessions For Eventget
  • Get Attendees For Eventget
  • Get Attendees for Event Sessionget

Academy Configuration

  • Update Allowed Email Domainsput
  • Remove Allowed Email Domaindel
  • Get Allowed Email Domainsget
  • Add Allowed Email Domainpost

Academy Webhook Subscriptions

  • Introduction to Webhooks
  • Webhook Subscription
  • Get All Webhook Subscriptionsget
  • Get Webhook Subscriptionget
  • Create Webhook Subscriptionpost
  • Edit Webhook Subscriptionpatch
  • Delete Webhook Subscriptiondel
Powered by 

By Contact

Endpoints in this group are for when you know a certain contact ID, and you want to get their learning activity.

Updated over 1 year ago


What are Trainings, Registrations and Enrollments?
Get All Registrations for a Contact
Did this page help you?

Updated over 1 year ago


What are Trainings, Registrations and Enrollments?
Get All Registrations for a Contact
Did this page help you?