API Reference
The EmbayLMS REST API is available at https://{your-subdomain}.embaylms.com/api/v1/.
The interactive OpenAPI spec is available at /api/v1/docs on your tenant subdomain.
Sections
| Section | Description |
|---|---|
| Getting Started | Base URL, versioning, and your first request |
| Authentication | API keys and Bearer token auth |
| Pagination & Filtering | Page-based pagination and filter syntax |
| Rate Limits | Request limits and 429 handling |
| Errors | Error codes and response envelope |
| Plans | Public subscription-tier catalog (pricing, caps, capabilities) |
| Users | List and manage the tenant’s users |
| Courses | Course catalog and content management |
| Enrollments | List, manage, and read enrollment progress |
| Completions | Audit-grade course completion records |
| Billing Metrics | Server-to-server billable-usage pull (active/licensed users) |
| Groups | Group membership and assignments |
| Reports | Completion & enrollment reports (more report types planned) |
| Webhooks | Subscribe to LMS events (delivery planned) |
| LTI 1.3 | Launch EmbayLMS content from external platforms |