Built LMS Help Center

Endpoint Catalog

Browse the public API resource areas and the permissions they usually require.

Use this catalog to choose the API surface for an integration. Use the generated API Reference and Playground for exact methods, schemas, filters, response examples, and test requests.

GET /api/public/v1/docs/openapi

Core learning data

Resource areaRoute prefixCommon permissions
Users/users, /users/search, /users/bulkusers:read, users:write, users:delete
Groups/groupsgroups:read, groups:write, groups:delete
Courses/courses, /courses/search, /courses/{id}/modulescourses:read, courses:write, courses:manage, courses:delete
Categories and modules/categories, /modulescourses:read, courses:write, courses:delete
Course enrollments/course-enrollments, /courses/{id}/enrollments, /users/{id}/enrollmentsenrollments:read, enrollments:write, enrollments:delete
Learning paths/learning-paths, /learning-path-nodes, /learning-path-dependencies, /learning-path-rulespaths:read, paths:write, paths:manage, paths:delete
Learning path enrollments/learning-path-enrollmentsenrollments:read, enrollments:write

Assessments and credentials

Resource areaRoute prefixCommon permissions
Exams and attempts/exams, /exam-attempts, /exam-resultsassessments:read, assessments:write, assessments:manage, assessments:delete
Questions and banks/questions, /question-banksassessments:read, assessments:write, assessments:delete
Rubrics and grading/rubrics, /rubric-criteria, /grading-queue, /course-builder/grading-queueassessments:read, assessments:write, assessments:manage
Certificates/certificates, /certificate-issuances, /user-certifications, /learning-path-certificatescertificates:read, certificates:manage
Course builder submissions/course-builder/courses, /course-builder/submissionscourses:read, courses:write, assessments:read, assessments:write

Analytics and reporting

Resource areaRoute prefixCommon permissions
Dashboard analytics/analytics/dashboardanalytics:read
Course analytics/analytics/coursesanalytics:read
Learning path analytics/analytics/learning-pathsanalytics:read
User analytics/analytics/users/{id}/activity, /analytics/users/{id}/engagementanalytics:read
Organization analytics/analytics/organization/summary, /analytics/organization/trendsanalytics:read
Reports/reports, /reports/{report_id}/generate, /reports/jobs/{job_id}analytics:read, analytics:manage

Configuration, AI, and operations

Resource areaRoute prefixCommon permissions
AI generation and recommendations/ai/courses, /ai/learning-paths, /ai/recommendations, /ai/metricsai:use, ai:manage
Webhooks/webhooks, /webhook-deliveriesadmin:api
Settings and branding/settings, /settings/brandingsettings:read, settings:write
Custom fields/custom-fields, /custom-field-definitionssettings:read, settings:write
Email templates/email-templatessettings:read, settings:write
Security checks/security/audit, /security/rls-complianceadmin:audit, admin:system
API reference/docs/openapidocs:read

Common workflows

Sync learners into a data warehouse

  1. Fetch users with /users.
  2. Fetch enrollments with /course-enrollments.
  3. Fetch progress from /course-enrollments/{id}/progress.
  4. Fetch certificates from /certificate-issuances.
  5. Store the response meta.organization_id with each synced batch.

Build a course catalog integration

  1. Fetch published courses with /courses.
  2. Fetch module structure with /courses/{id}/modules.
  3. Use /categories for local grouping.
  4. Subscribe to course.published and course.updated webhooks to refresh stale catalog data.

Connect customer success reporting

  1. Fetch dashboard metrics from /analytics/dashboard.
  2. Pull course or learning path analytics for drill-downs.

On this page