Skip to main content

Learnsters Public API

An overview of the Learnster Public API — key features, how to get started, and where to find documentation.

Written by Liam Basham
Updated this week

At Learnster, we believe in the power of seamless integration to enhance your learning experience. Our Public API opens up a world of possibilities for you to integrate and automate various aspects of our platform.

Key Features of the Learnster API

User Management: Easily manage users (referred to as "Students" in our API), including creating, updating, and deleting user profiles.

Course Management: Access and manage course data, including listing available courses (referred to as "Sessions") and enrolling students.

Custom Attributes and Tags: Customize user profiles and courses with tags and custom attributes, adding more depth to your data.

Authentication: Secure and straightforward authentication using OAuth2, ensuring safe access to the API

Data Analysis: Export comprehensive lists of user data, including teams, tags, and course history (referred to as "Sessions"), to better understand user engagement and performance.


Getting Started Is Easy

Generate Your Client Credentials: Create a new client application in Learnster Studio to get your unique Client ID and Client Secret.

Authenticate and Receive Your Token: Use your credentials to authenticate and receive a token for accessing the API.

Start Making API Calls: Use the token to make authorized calls to our API and start integrating!


Where to Find More Information

Introduction to our API: Can be found at https://learnsterpublicapi.docs.apiary.io/

Detailed API Documentation: For specific instructions and endpoint details, check out our comprehensive Swagger documentation. Visit https://your-workspace-url.learnster.com/api/public/v1/swagger/

Test the API with Postman: Want to try things out hands-on? You can import our Swagger definition straight into Postman and start testing endpoints in minutes. Check out our guide: Testing the Learnster API with Postman

Frequently asked questions: You can find some of our most frequently asked questions in this article here.


Need more help? 🤝

💬 Talk to us

  • AI Support (Fin) — Open the chat in Learnster Studio and ask our AI assistant. Fin is trained on our API documentation and can answer many technical questions instantly.

  • "Real" support — Need a human? You can reach our support team in the same chat from Learnster Studio. Just ask to speak to a person and we'll be happy to help!

🤖 Use AI to accelerate your work

You can also use ChatGPT, Claude, or your AI tool of choice to help with your integration. Point it at these sources for the best results:

Feed it the Swagger spec and your question, and it can help you build requests, debug responses, and write integration code.

💡 Pro tip: If you use Claude, it can even connect directly to your Postman workspace and test API calls for you!

Did this answer your question?