API Reference
The EmbayLMS REST API is available at https://{your-subdomain}.embaylms.com/api/v1/.
The OpenAPI 3.0 spec (JSON) is available at /api/v1/docs on your tenant subdomain — load it into Swagger UI or your client generator — or import the ready-made Postman collection.
Sections
| Section | Description |
|---|---|
| Getting Started | Base URL and your first request |
| Postman Collection | Import every endpoint into Postman — ready environment, tests, and sample code in 20+ languages, regenerated from the spec on every release |
| Versioning & Deprecation | What may change inside v1, the 12-month deprecation window, and the RFC 8594 headers to watch for |
| 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 |
| Skills | Job roles and required levels, a person’s skills, the team skills matrix |
| Reports | Completion, enrollment, compliance, user-activity & course-performance reports, plus async CSV/XLSX export |
| Webhooks | Subscribe to LMS events — signed HTTP push with retries |
| LTI 1.3 | Launch EmbayLMS content from external platforms |