API Reference and Playground
Browse the generated Built LMS public API reference and send test requests.
The API reference is generated from the public API route handlers in Built LMS. Use it to inspect request parameters, response schemas, authentication, and example responses before sending a request from the playground.
Browse by area
Courses and Catalog
Courses, modules, categories, publishing, search, and catalog operations.
Enrollments and Progress
Enrollment records, progress updates, interaction events, and completion data.
Users and Groups
User search, user analytics, groups, memberships, and user progress.
Webhooks
Webhook subscriptions, event types, delivery history, retries, and tests.
Analytics and Reporting
Analytics endpoints, reports, and survey exports.
Assessments
Exams, attempts, questions, rubrics, and assessment results.
Learning Paths
Learning paths, rules, nodes, dependencies, enrollments, and progress.
Settings
Organization settings, custom fields, and email templates.
Before sending requests
- Set the server URL to your Built LMS domain.
- Add an API key in the authorization field as a bearer token.
- Use an API key that has only the permissions needed for the endpoint.
- Test write operations against a non-production organization first.
Raw OpenAPI document
The application exposes the same generated OpenAPI document at:
GET /api/public/v1/docs/openapiThat route requires an API key with docs:read permission.