API Reference
Log In
API Reference

Getting Started

Getting Started with the Learningbank API

The Learningbank API gives you programmatic access to your Workforce Enablement Platform - letting you sync users, manage organizational structure, and pull learning data into your own systems.


Base URL

All API requests are made to:

https://public-api.lbservice.net

Step 1: Generate an API Key

Before you can make any requests, you need to generate API credentials from within your Learningbank platform.

Follow the Create an API Key guide in the Help Center. This will give you a username and password - store these safely, as the password is only shown once.


Step 2: Authenticate

Exchange your credentials for a short-lived bearer token using /authenticate:

POST /authenticate
Content-Type: application/json

{
  "credentials": {
    "username": "your-username",
    "password": "your-password"
  }
}

Include the returned token in all subsequent requests, in an Authorization header:

Authorization: Bearer <your-token>
📘

Tokens are short-lived (1 hour). Your integration should handle re-authentication when a token expires.

Forwarding users to Learningbank (SSO)

If you're building an integration that redirects users from your own system into Learningbank, use /authenticate/signin-token instead. This issues a one-time token tied to a user's email that you append to the redirect URL.


What the API covers

Management

Manage users, events and your organizational structure - departments, permissions, and job profiles. Creating and updating users is done exclusively through /users/upsert - a single bulk endpoint that handles creates, updates, and deactivations in one call.

Custom Fields

Through /users/upsert, it is also possible to set custom field values on users. Note that only the values can be set via the API - the custom fields themselves must be created manually in the Learningbank platform first.

⚠️

Custom fields are only available to certain packages. If custom fields are locked for you, please reach out to support or your dedicated Customer Success Manager.

For more information, see Custom Fields in the Help Center.

Learning & Tracking

Read-only access to learning content, events and completion data - modules, learning paths, journeys, and completion history. Use these to feed dashboards, BI tools, or external reporting systems.

/completion-data is deprecated - use /completion-history instead.


Rate Limits

The API enforces two throttle windows per endpoint:

WindowLimit
10 seconds60 requests
1 minute120 requests

Design your integration to respect these limits. Going above the limit, will result in the API to return a HTTP status 429.


Next Steps

  • Browse the full endpoint reference in the sidebar
  • Visit the Learningbank Help Center for platform concepts and best practices