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
Resource area Route prefix Common permissions Users /users, /users/search, /users/bulkusers:read, users:write, users:deleteGroups /groupsgroups:read, groups:write, groups:deleteCourses /courses, /courses/search, /courses/{id}/modulescourses:read, courses:write, courses:manage, courses:deleteCategories and modules /categories, /modulescourses:read, courses:write, courses:deleteCourse enrollments /course-enrollments, /courses/{id}/enrollments, /users/{id}/enrollmentsenrollments:read, enrollments:write, enrollments:deleteLearning paths /learning-paths, /learning-path-nodes, /learning-path-dependencies, /learning-path-rulespaths:read, paths:write, paths:manage, paths:deleteLearning path enrollments /learning-path-enrollmentsenrollments:read, enrollments:write
Resource area Route prefix Common permissions Exams and attempts /exams, /exam-attempts, /exam-resultsassessments:read, assessments:write, assessments:manage, assessments:deleteQuestions and banks /questions, /question-banksassessments:read, assessments:write, assessments:deleteRubrics and grading /rubrics, /rubric-criteria, /grading-queue, /course-builder/grading-queueassessments:read, assessments:write, assessments:manageCertificates /certificates, /certificate-issuances, /user-certifications, /learning-path-certificatescertificates:read, certificates:manageCourse builder submissions /course-builder/courses, /course-builder/submissionscourses:read, courses:write, assessments:read, assessments:write
Resource area Route prefix Common permissions Dashboard analytics /analytics/dashboardanalytics:readCourse analytics /analytics/coursesanalytics:readLearning path analytics /analytics/learning-pathsanalytics:readUser analytics /analytics/users/{id}/activity, /analytics/users/{id}/engagementanalytics:readOrganization analytics /analytics/organization/summary, /analytics/organization/trendsanalytics:readReports /reports, /reports/{report_id}/generate, /reports/jobs/{job_id}analytics:read, analytics:manage
Resource area Route prefix Common permissions AI generation and recommendations /ai/courses, /ai/learning-paths, /ai/recommendations, /ai/metricsai:use, ai:manageWebhooks /webhooks, /webhook-deliveriesadmin:apiSettings and branding /settings, /settings/brandingsettings:read, settings:writeCustom fields /custom-fields, /custom-field-definitionssettings:read, settings:writeEmail templates /email-templatessettings:read, settings:writeSecurity checks /security/audit, /security/rls-complianceadmin:audit, admin:systemAPI reference /docs/openapidocs:read
Fetch users with /users.
Fetch enrollments with /course-enrollments.
Fetch progress from /course-enrollments/{id}/progress.
Fetch certificates from /certificate-issuances.
Store the response meta.organization_id with each synced batch.
Fetch published courses with /courses.
Fetch module structure with /courses/{id}/modules.
Use /categories for local grouping.
Subscribe to course.published and course.updated webhooks to refresh
stale catalog data.
Fetch dashboard metrics from /analytics/dashboard.
Pull course or learning path analytics for drill-downs.