API Documentation

REST + JSON over HTTPS.

The Learnly REST API allows you to programmatically interact with your organization's learning data. You can manage courses, users, teams, and track progress via the API. All API access is over HTTPS, and all data is sent and received as JSON.

Authentication and IDs

Authenticate your API requests by including your secret API key in the X-API-Key header. You must also provide your organization's domain ID in the X-Domain-ID header. You can find both of these in your Learnly admin settings.

Endpoints with :id in the path require you to replace :id with the actual UUID of the resource. You can find UUIDs on listing pages (Courses, Assessments, Teams, People) — click the displayed ID to copy it to your clipboard, or use the "Copy ID" option in item dropdown menus.

What you can do

Courses: list all courses in the organization, get course details by ID, or create a new course.

Assessments: list all assessments and get assessment details by ID.

Learners: get course progress for a learner or get assessment results for a learner.

Users: create a new user or delete a user.

Teams: get course progress for a team, get assessment results for a team, create a new team, or delete a team.

Enrollments: enroll or unenroll a user in a course or assessment.