Public API: Getting Started

Want to build your own integrations, automate workflows, or export data from Learningbank? Our Public API lets you do exactly that!

The Public API is an open REST API that gives you direct access to your Learningbank data. Whether you want to build a custom integration, sync data with another system, or automate processes - the Public API is your starting point.

Sounds interesting? Take a look at our technical API documentation and see what's possible! 👉Getting Started

Our Public API is continuously updated with new features and possibilities. Want to build your own integration or export data from Learningbank? Keep on reading to see what is currently supported!

The Public API supports retrieving completion data for both modules and learning paths. You can get completions for all users or specific users, and filter by date intervals.

Completion data only returns users who have fully completed a module or learning path - not users who are partially through or have not started. It also includes when the completion happened.

A great use case for this is exporting learning data into external tools like Power BI, where you can combine it with data from other systems to get a fuller picture of your organization's learning activity.

The Public API supports retrieving information about events, sessions and registrations.

The Public API supports retrieving, creating, updating and deactivating users. The information available is the same as what you find on the user page in the platform.

Beyond just reading user data, the API can also automatically handle creating, updating and deactivating users - including assigning job profiles, departments, permissions and managers. This gives you the same possibilities as our standard integrations, but built your way.

It is possible to retrieve the profile pictures of users through the Public API. A common use case is customers who want to print access cards for their employees, using the profile picture the user has uploaded to Learningbank.

Job Profiles

The Public API supports getting, creating, updating and deleting job profiles. You can retrieve general information such as the name, create new job profiles, update them if the name changes, or delete them entirely - as long as no users are currently assigned to them.

The Public API supports getting, creating, updating and deleting permissions. You can retrieve general information such as the name, description and whether it is an owner permission, create new permissions, update them if the name or description changes, or delete them entirely - as long as no users are currently assigned to them.

The Public API supports getting, creating, updating and deleting departments. You can retrieve general information such as the name and where the department sits in the hierarchy, create new departments, update them if the name or placement in the hierarchy changes, or delete them entirely - as long as no users are currently assigned to them.

A common use case is automating the department hierarchy in Learningbank - instead of building and maintaining it manually, customers retrieve the structure from another system and automatically mirror it in the platform.

It is possible to retrieve general information about modules, learning paths and journeys - such as name, description, when they were created or last updated, and whether they are published.

It is not possible to create, update or delete modules, learning paths or journeys through the API. For information about whether a user has completed one, see the Completion Data section above.

The Public API supports getting, creating, updating and deleting additional access roles. You can retrieve general information such as what the role currently grants access to and its validity period, create new access roles on users, update them if the validity or access needs to change, or delete them entirely.

The Public API supports retrieving certificates from the platform. You can get a list of all certificates with general information such as name, description, category and expiration settings.

It is also possible to look up which users hold a specific certificate, and what state their certificate is in - whether it is valid, almost expired, expired or not yet started. You can filter by state and expiration date ranges to get exactly the data you need.

The reverse is also possible - retrieving all certificates belonging to a specific user, giving you a full overview of what a user currently holds and when they expire.

A great use case for this is exporting certificate data into external reporting tools, to keep track of compliance and make sure the right people have the right certifications before they expire. 📋

The Public API is currently on version 2. Version 1 has been phased out and is no longer available. The documentation has been removed as well, to make sure no one is confused about what version to use.