WorkRamp
API integration

list_all_work_ramp_users

List WorkRamp enterprise users with optional filtering by email, name, or custom attributes. Returns each user with id, name, email, isAdmin, isDeleted, isPermanentlyDeleted, createdAt, updatedAt, directReports, and certifications.

create_a_work_ramp_user

Create a new WorkRamp user. Returns the created user with id, name, email, isAdmin, isDeleted, createdAt, updatedAt, mentors, and groups. Required: email.

update_a_work_ramp_user_by_id

Update an existing WorkRamp user by id. Returns the updated user with id, name, email, isAdmin, isDeleted, isPermanentlyDeleted, createdAt, updatedAt, mentors, and mentorsViaGroups. Required: id.

delete_a_work_ramp_user_by_id

Delete a WorkRamp user by id. Returns true on successful deletion. Required: id.

work_ramp_users_assignments

List all assignments for a WorkRamp user grouped by assignment type. Returns: challenge_assignments, guide_assignments, path_assignments, scorm_assignments. Required: user_id.

work_ramp_users_attributes

List WorkRamp users with their custom attributes. Returns: id, email, created_at, updated_at, user. Legacy_mode defaults to true, bypassing pagination for accounts created before November 11, 2025; may be deprecated in a future API version.

list_all_work_ramp_groups

List WorkRamp groups for the enterprise. Returns: id, enterpriseId, name, originalName, hasManagers, fromSso, groupAutomationsCount, activeGroupAutomationsCount, description, createdAt, updatedAt.

create_a_work_ramp_group

Create a new WorkRamp group. Returns the created group including id, enterpriseId, name, originalName, description, hasManagers, fromSso, groupAutomationsCount, activeGroupAutomationsCount, createdAt, and updatedAt. Required: name.

update_a_work_ramp_group_by_id

Update an existing WorkRamp group by id. Returns the updated group including id, name, originalName, description, hasManagers, fromSso, groupAutomationsCount, activeGroupAutomationsCount, enterpriseId, createdAt, and updatedAt. Required: id.

work_ramp_groups_assign_user

Assign a user to a WorkRamp group. Returns true on success. Required: group_id, userId.

list_all_work_ramp_user_attributes

List custom user attributes for a WorkRamp user. Returns a dynamic map of custom attribute API names to their values. Example keys: Location, Indirect manager. Required: user_id.

delete_a_work_ramp_user_attribute_by_id

Delete specific custom user attributes for a WorkRamp user by id. Pass an array of attribute API names to remove. Returns a boolean true on success. Required: id.

update_a_work_ramp_user_attribute_by_id

Set or update custom user attributes for a WorkRamp user by id. Pass a dictionary of attribute API names to new values. Returns a boolean true on success. Required: id, attributes. Date-type attributes should use ISO8601 format (e.g., 2024-12-31).

list_all_work_ramp_guides

List WorkRamp guides. Returns: id, title, num_total_tasks, num_total_test_questions, created_at, updated_at, tags. The legacy_mode parameter (defaults to true) bypasses pagination for accounts created before November 11, 2025, returning all results in a single non-paginated response.

create_a_work_ramp_guide_assignment

Create a WorkRamp guide assignment by assigning a guide to a user. Returns: id, userId, title, courseId, trainingSeriesUserAssignmentId, dueDate, numViewedTasks, numCompletedTasks, numCompletedTestQuestions, numGradedTestQuestions, numCorrectTestQuestions, score, isArchived, isCompleted, createdAt, updatedAt, completedAt. Required: guide_id, userId. Use email as an alternative to userId when the…

update_a_work_ramp_guide_assignment_by_id

Update a WorkRamp guide assignment's due date, completion status, score, or completed date. Returns: id, userId, title, courseId, trainingSeriesUserAssignmentId, dueDate, numViewedTasks, numCompletedTasks, numCompletedTestQuestions, numGradedTestQuestions, numCorrectTestQuestions, score, isArchived, isCompleted, createdAt, updatedAt, completedAt. Required: id. Providing completedDate or score…

delete_a_work_ramp_guide_assignment_by_id

Delete a WorkRamp guide assignment by id. Returns a boolean indicating whether the deletion was successful. Required: id.

list_all_work_ramp_guide_assignments

List WorkRamp guide assignments within a date range or by due date. Returns: user, guide, guide_assignment. You must provide either start_time (and optionally end_time) or due_date. Max 200 results per page.

work_ramp_guide_assignments_by_guide

List all guide assignments for a specific guide in WorkRamp. Returns: id, user_id, title, course_id, training_series_user_assignment_id, training_series_user_assignment_ids, assigner_id, due_date, num_viewed_tasks, num_completed_tasks, num_completed_test_questions, num_graded_test_questions, num_correct_test_questions, score, is_archived, is_completed, completion_percentage, created_at,…

list_all_work_ramp_guide_assignment_changes

List WorkRamp guide assignment changes within a time range. Returns: guideId, id, occurredAt, status, trainingSeriesId, guideName, userId, userEmail. Required: startTime, endTime. This endpoint is deprecated; consider using the Date Range endpoint instead.

get_single_work_ramp_path_assignment_by_id

Get a single WorkRamp path assignment by id. Returns: id, userId, title, trainingSeriesId, assignerId, overallGrade, isCompleted, dueDate, createdAt, updatedAt, createdThrough, numModules, modulesCompleted, completionPercentage, completedAt, tags, timeSpent, status, isCompletedOnTime, passed, passingGradeRequired, isOverdue, numDaysOverdue, firstAccessedAt, lastAccessedAt. Required: id.

create_a_work_ramp_path_assignment

Create a WorkRamp path assignment by assigning a path to a user. Returns: id, userId, trainingSeriesId, assignerId, dueDate, isCompleted, createdAt, updatedAt, createdThrough, numModules, modulesCompleted. Required: path_id, userId.

update_a_work_ramp_path_assignment_by_id

Update a WorkRamp path assignment by id, such as changing the due date or soft-deleting. Returns: id, userId, trainingSeriesId, assignerId, dueDate, isCompleted, createdAt, updatedAt, createdThrough, numModules, modulesCompleted. Required: id.

delete_a_work_ramp_path_assignment_by_id

Delete (unassign) a WorkRamp path assignment by id. Returns true on success. Required: id.

list_all_work_ramp_path_assignments

List WorkRamp path assignments created or updated within a date range, or filtered by due date. Returns: path, pathAssignment, user, is_deleted. Must provide either start_time (with optional end_time) or due_date.

work_ramp_path_assignments_by_path

List assignments for a specific WorkRamp path, optionally filtered by user. Returns: id, user_id, title, training_series_id, assigner_id, overall_grade, is_completed, due_date, created_at, updated_at, created_through, num_modules, modules_completed, completion_percentage, completed_at, tags, time_spent, status, is_completed_on_time, passed, passing_grade_required, is_overdue, num_days_overdue,…

list_all_work_ramp_events

List WorkRamp events with their sessions and learner details. Returns: id, name, type, sessions. Supports optional date-range filtering by session start/end times and group exclusion.

create_a_work_ramp_event

Create a new WorkRamp event. Returns: id, type. Required: name.

get_single_work_ramp_event_session_by_id

Get a single WorkRamp event session by id. Returns the session object including id, trainingClassId, title, start, end, and Zoom meeting details. Required: event_id, id.

create_a_work_ramp_event_session

Create a new event session in WorkRamp. Returns the created session including id, trainingClassId, title, start, end, and Zoom meeting details. Required: event_id, title.

work_ramp_event_sessions_invite_users

Invite users and groups to a WorkRamp event session. Returns: status_code, message. Required: event_id, session_id.

list_all_work_ramp_resources

List all WorkRamp resources. Returns: id, name, description, createdAt, updatedAt.

create_a_work_ramp_scim_user

Create a new WorkRamp SCIM user with email, name, groups, manager details, and custom attributes. Returns: schemas, id, userName, name, emails, active, meta.

list_all_work_ramp_libraries

List WorkRamp libraries (universities). Returns each library's id, name, type, is_published, is_private, group_ids, user_ids, created_at, and updated_at.

get_single_work_ramp_library_by_id

Get a single WorkRamp library (university) by id. Returns: id, created_at, description, group_ids, is_deleted, is_private, is_published, item_folder_id, name, sort_order, type, udemy, ui_order, updated_at, user_ids. Required: id.

update_a_work_ramp_library_by_id

Update a WorkRamp library (university) by id, modifying its public visibility and access permissions. Returns: id, created_at, description, group_ids, is_deleted, is_private, is_published, item_folder_id, name, sort_order, type, udemy, ui_order, updated_at, user_ids. Required: id. If permissions is provided, all existing user and group access is replaced; an empty object removes all access.

list_all_work_ramp_item_folders

List WorkRamp item folders as a hierarchical tree. Returns: id, name, order, parentItemFolderId, isHidden, isLocked, createdAt, updatedAt, children.

create_a_work_ramp_item_folder

Create a WorkRamp item folder. If a folder with the same name already exists, the existing folder is returned instead. Returns: id, name, order, parentItemFolderId, isHidden, isLocked, createdAt, updatedAt. Required: name.

update_a_work_ramp_item_folder_by_id

Update a WorkRamp item folder by id. Providing permissions replaces all existing user and group access. Returns: id, name, order, parentItemFolderId, isHidden, isLocked, createdAt, updatedAt. Required: id.

delete_a_work_ramp_item_folder_by_id

Delete a WorkRamp item folder by id. All content and sub-folders within the folder are also deleted. Returns an empty 200 response on success. Required: id.

list_all_work_ramp_scorms

List WorkRamp SCORMs ordered by creation date. Returns each SCORM's id, title, created_at, and time_estimate.

update_a_work_ramp_scorm_assignment_by_id

Update a SCORM assignment in WorkRamp by id, typically to set or change the due date. Returns: id, assignerUserId, completionPercentage, dueAt, dueDate, isCompleted, score, tags, topLevelContentId, trainingSeriesUserAssignmentIds. Required: id.

delete_a_work_ramp_scorm_assignment_by_id

Delete a SCORM assignment in WorkRamp by id. Returns an empty 204 response on success. Required: id.

work_ramp_scorm_assignments_bulk_create

Bulk create SCORM assignments in WorkRamp by assigning a SCORM package to groups, users, or email addresses. Returns: assignment. Required: scorm_id. At least one of group_ids, user_ids, or user_emails must be provided.

work_ramp_scorm_assignments_bulk_delete

Bulk delete SCORM assignments in WorkRamp. Returns: assignment. Required: scorm_id, assignment_ids.

list_all_work_ramp_scorm_assignments

List SCORM assignments in WorkRamp within a date range. Returns each assignment's scorm, scormAssignment, user, and is_deleted fields. You must provide either start_time (and optionally end_time) or due_date.

work_ramp_scorm_assignments_by_scorm

List users assigned to a SCORM package in WorkRamp. Returns a scorm object (id, display_title, description, folder_id, source_id, created_at, updated_at) and an assignments array where each item includes completed_at, completion_percentage, due_date, date_assigned, assigner, time_spent_in_minutes, and a user object (name, email). Required: scorm_id. Set legacy_mode to false for standard…

work_ramp_content_copy

Copy a SCORM content item to a new item folder in WorkRamp. Returns: id, sourceId, folderId, displayTitle, description, createdAt, updatedAt. Required: content_type, content_id, item_folder_id. The content_id can exist in the parent enterprise.

list_all_work_ramp_challenge_assignments

List user assignments for a WorkRamp challenge. Returns: challenge, challenge_user_assignments. Required: challenge_id. legacy_mode defaults to true for accounts created before November 11, 2025, returning the full dataset in a single non-paginated response.

list_all_work_ramp_content_catalog

List WorkRamp content catalog items including guides, paths, and challenges. Returns: folderName, universityName, universityDescription, universityFolder, pathName, pathDescription, itemType, itemName, itemDescription, itemLink, lastEditedDate, lastEditor, lastAssignedDate, numAssignments, originalAuthor, createdDate.

list_all_work_ramp_elc_webhooks

List WorkRamp ELC webhook subscriptions. Returns: id, eventTypes, name, url.

get_single_work_ramp_elc_webhook_by_id

Get a single WorkRamp ELC webhook subscription by id. Returns: id, eventTypes, name, url. Required: id.

create_a_work_ramp_elc_webhook

Create a new WorkRamp ELC webhook subscription. Returns the created subscription including id, eventTypes, name, and url. Required: name, url, eventTypes.

update_a_work_ramp_elc_webhook_by_id

Update an existing WorkRamp ELC webhook subscription by id. Returns the updated subscription including id, eventTypes, name, and url. Required: id.

delete_a_work_ramp_elc_webhook_by_id

Delete a WorkRamp ELC webhook subscription by id. Returns an empty 204 response on success. Required: id.

list_all_work_ramp_reseller_customers

List WorkRamp white-label (reseller) customers. Returns each customer record including id, enterprise_id, enterprise_name, enterprise_base_url, disable_all_emails, created_at, and updated_at.

list_all_work_ramp_academy_contacts

List WorkRamp academy contacts (users) with optional filtering by name, email, email domain, exact email, status, and custom registration fields. Returns: id, email, segments, display_name, first_name, last_name, created_at, custom_registration_field_values, status. Required: academy_id.

get_single_work_ramp_academy_contact_by_id

Get a single WorkRamp academy contact by id. Returns: id, email, segments, display_name, first_name, last_name, created_at, custom_registration_field_values, status. Required: academy_id, id.

create_a_work_ramp_academy_contact

Create a new WorkRamp academy contact (user). Returns the created contact including id, email, display_name, first_name, last_name, created_at, segments, custom_registration_field_values, and status. Required: academy_id, email, name.

update_a_work_ramp_academy_contact_by_id

Update a WorkRamp academy contact by id. Returns the updated contact including id, email, display_name, first_name, last_name, created_at, segments, custom_registration_field_values, and status. Required: academy_id, id.

delete_a_work_ramp_academy_contact_by_id

Delete a WorkRamp academy contact by id. Returns an empty 200 response on success. Required: academy_id, id.

work_ramp_academy_contacts_invite

Invite contacts to a WorkRamp academy by email. Returns: custom_registration_fields. Required: academy_id, userEmailsToInvite.

work_ramp_academy_segments_add_users

Add users to a WorkRamp academy segment by email. Returns: numAddedToGroup, numConvertedToManual, numAlreadyInGroup, numDeletedUser, numUnregisteredUser. Required: academy_id, segment_id, userEmails. Contacts must be registered to be placed in a segment.

work_ramp_academy_segments_remove_users

Remove users from a WorkRamp academy segment by email. Returns: status, numAddedToGroup, numConvertedToManual, numAlreadyInGroup, numDeletedUser, numUnregisteredUser. Required: academy_id, segment_id.

work_ramp_academy_segments_invite_users

Invite users to a WorkRamp academy segment by email. Returns: numAddedToGroup, numConvertedToManual, numAlreadyInGroup, numDeletedUser, numUnregisteredUser. Required: academy_id, segment_id. Contacts must be registered to be placed in a segment.

work_ramp_academy_registrations_get_by_contact

Get a specific registration for a contact in a WorkRamp academy. Returns: user_id, registration. Required: academy_id, contact_id, registration_id.

list_all_work_ramp_academy_registrations

List registrations for a WorkRamp academy. Returns: id, completed_at, completion_percentage, created_at, due_at, due_date, grading_status, is_completed, pass_status, score, time_spent, enrollment_method, internal_assigner_id, content, user. Required: academy_id.

delete_a_work_ramp_academy_registration_by_id

Delete (unassign) a WorkRamp academy registration by id. Returns true on success. Required: academy_id, id.

update_a_work_ramp_academy_registration_by_id

Update a WorkRamp academy registration by id, marking it complete and optionally setting a score. Returns: id, score, created_at, time_spent, pass_status, is_completed, completed_at, completion_percentage. Required: academy_id, id, is_completed. Currently is_completed only supports the value true.

get_single_work_ramp_academy_registration_by_id

Get a single registration in a WorkRamp academy by id. Returns the registration object including id, completed_at, is_completed, completion_percentage, score, pass_status, due_at, due_date, grading_status, time_spent, and nested content. Required: academy_id, id.

work_ramp_academy_registrations_by_contact

List all registrations for a specific contact in a WorkRamp academy. Returns: id, completed_at, completion_percentage, created_at, due_at, due_date, grading_status, is_completed, pass_status, score, time_spent, enrollment_method, internal_assigner_id, content. Required: academy_id, contact_id.

work_ramp_academy_registrations_by_training

List all registrations for a specific training in a WorkRamp academy. Returns: id, completed_at, completion_percentage, created_at, due_at, due_date, grading_status, is_completed, pass_status, score, time_spent, enrollment_method, internal_assigner_id, content. Required: academy_id, training_id.

work_ramp_academy_registrations_by_contact_deprecated

List all registrations for a user in a WorkRamp academy via the deprecated users path. Returns: id, completed_at, completion_percentage, created_at, due_at, due_date, grading_status, is_completed, pass_status, score, time_spent, enrollment_method, internal_assigner_id, content. Required: academy_id, contact_id. Deprecated — use by_contact instead.

work_ramp_academy_path_enrollments_by_contact

List all path enrollments for a specific contact in a WorkRamp academy. Returns: id, awarded, awarded_at, can_recertify, completed, completed_at, created_at, due_at, expired, expires_at, has_learner_seen_award, has_learner_seen_completed_and_requires_grading, is_completed_and_requires_grading, is_started, last_accessed_at, path, progress_percentage, public_url, short_id, time_spent_cache,…

work_ramp_academy_path_enrollments_by_path

Get all enrollments for a specific path in a WorkRamp academy. Returns: id, name, email, completed_at, assigner_user_id, enrollment_method, progress_percentage. Required: academy_id, path_id.

work_ramp_academy_path_enrollments_completed

List path user enrollment records in a WorkRamp academy. Returns: id, user_id, user_name, user_email, path_id, path_name, path_description, progress_percentage, completed_at. Required: academy_id. Defaults to completed records only; set completed_only to false for all enrollments.

list_all_work_ramp_academy_awarded_certifications

List awarded certifications in a WorkRamp academy. Returns: id, name, description, user_id, user_name, user_email, awarded_at. Required: academy_id. Supports filtering by start and end datetime (10-digit epoch seconds).

work_ramp_academy_awarded_certifications_by_contact

List awarded certifications for a specific user in a WorkRamp academy. Returns: id, badge_image, display_title. Required: academy_id, contact_id.

work_ramp_academy_certification_enrollments_by_contact

List all certification enrollments for a specific contact in a WorkRamp academy. Returns the contact object (id, display_name, email, first_name, last_name) and a certification_enrollments array where each item includes id, awarded, completed, progress_percentage, and a nested certification object. Required: academy_id, contact_id.

work_ramp_academy_certification_enrollments_by_certification

Get a specific certification and its awarded enrollments in a WorkRamp academy. Returns the certification object (id, name, description, awarded_by_name, awarded_by_title, created_at) and an awarded_certifictions array where each item includes id, name, email, awarded_at, enrollment_method, assigner_user_id, and progress_percentage. Required: academy_id, cert_id.

work_ramp_academy_trainings_assign

Invite users to a WorkRamp training by email. Returns: errors, assignments, trainingInvitations. Required: academy_id, training_id.

list_all_work_ramp_academy_trainings

List all trainings in a WorkRamp academy. Returns: id, type, name, created_at, card_banner, description, time_estimate_seconds. Required: academy_id.

get_single_work_ramp_academy_training_by_id

Get a single WorkRamp training by id. Returns the training object including id, type, name, created_at, card_banner, description, and time_estimate_seconds. Required: academy_id, id.

work_ramp_academy_trainings_search

Search for trainings in a WorkRamp academy by search term. Returns: id, type, title, name, created_at. Required: academy_id, search_term.

work_ramp_academy_certifications_assign

Invite contacts to a WorkRamp certification by email, optionally with a due date. Returns: errors, assignments, trainingInvitations. Required: academy_id, certification_id.

list_all_work_ramp_academy_certifications

List all certifications in a WorkRamp academy. Returns: id, name, description, created_at, awarded_by_name, awarded_by_title. Required: academy_id.

get_single_work_ramp_academy_certification_by_id

Get detailed information about a specific WorkRamp certification including its content items. Returns: certification, banner_image, id, title. Required: academy_id, id.

work_ramp_academy_paths_assign

Invite contacts to a WorkRamp academy path by email, optionally with a due date. Returns an empty 200 response on success. Required: academy_id, path_id.

list_all_work_ramp_academy_paths

List all paths in a WorkRamp academy. Returns: id, name, description, created_at. Required: academy_id.

get_single_work_ramp_academy_path_by_id

Get detailed information about a specific WorkRamp academy path including its certification contents and training items. Returns: id, title, banner_image, path. Required: academy_id, id.

list_all_work_ramp_academy_collections

List collections in a WorkRamp academy. Returns: id, name, description, created_at. Required: academy_id.

get_single_work_ramp_academy_collection_by_id

Get a single WorkRamp academy collection by id. Returns the collection object including its academy_collection_contents array with content entries (id, content_id, content_type) and nested content details (title, description, time_estimate_seconds). Required: academy_id, id.

list_all_work_ramp_academy_events

List all academy events in WorkRamp for a given academy. Returns: created_at, description, id, num_live_sessions, num_on_demand_content, published, title, updated_at. Required: academy_id.

get_single_work_ramp_academy_event_by_id

Get a single WorkRamp academy event by id. Returns the event object including id, title, description, published, created_at, updated_at, num_live_sessions, num_on_demand_content, and academy_event_sessions with session details. Required: academy_id, id.

work_ramp_academy_event_attendees_by_event

List attendees for a specific event in a WorkRamp academy. Returns: id, didAttend, isRegistered, registeredAndMarkedAttended, registeredAndSessionHasPassed, registrationStatus, status, createdAt, declinedAt, googleCalendarStatusUpdatedAt, registrationDate, updatedAt, waitlistedAt. Required: academy_id, event_id.

work_ramp_academy_event_attendees_by_session

List attendees for a specific event session in a WorkRamp academy. Returns: id, didAttend, isRegistered, registeredAndMarkedAttended, registeredAndSessionHasPassed, status, createdAt, declinedAt, registrationDate, updatedAt, waitlistedAt. Required: academy_id, event_session_id.

list_all_work_ramp_academy_email_domains

Get the email domain configuration for a WorkRamp academy, including allowed and blocked domain lists with their enabled flags. Returns: emailDomainsAllowed, emailDomainsAllowedEnabled, emailDomainsBlocked, emailDomainsBlockedEnabled. Required: academy_id.

create_a_work_ramp_academy_email_domain

Add email domains to the existing allowed list for a WorkRamp academy. Returns: emailDomainsAllowed, emailDomainsAllowedEnabled, emailDomainsBlocked, emailDomainsBlockedEnabled. Required: academy_id, email_domains.

work_ramp_academy_email_domains_bulk_update

Update the allowed email domains configuration for a WorkRamp academy. Returns: emailDomainsAllowed, emailDomainsAllowedEnabled, emailDomainsBlocked, emailDomainsBlockedEnabled. Required: academy_id, email_domains.

work_ramp_academy_email_domains_bulk_delete

Remove email domains from the existing allowed list for a WorkRamp academy. Returns: emailDomainsAllowed, emailDomainsAllowedEnabled, emailDomainsBlocked, emailDomainsBlockedEnabled. Required: academy_id, email_domains.