The Thrive API lets you programmatically access, extend, and integrate with our learning platform. It's designed for developers looking to connect Thrive with internal systems, automate content delivery, or build custom insights and integrations.
What You Can Do
With the Thrive API, you can:
Retrieve data about your learning platform — users, courses, completions, and more.
Make updates from other systems directly into Thrive.
Automate workflows — for example, enrolling users, managing content tags and learner’s skills, or syncing completion data.
Set up audiences and personalise learning at scale.
The API is designed to be flexible and consistent, whether you’re building a one-off integration or embedding Thrive data into enterprise systems.
Organised Around REST
The Thrive API is organised around the REST (Representational State Transfer) standard: a proven, predictable design pattern used by most modern web APIs.
This approach means:
Each resource (like a user, course, or completion record) has its own unique URL.
You interact with resources using standard HTTP methods:
GET to retrieve data.
POST to create or push new data.
PUT or PATCH to update data.
DELETE to remove data.
All responses are in JSON, making them easy to parse and use in any modern programming language.
This approach keeps the API simple, predictable, and easy to learn.
Authentication
Access to the Thrive API is secured using basic authentication, consisting of a username (your tenant-id) and a password (the API key you must first generate).
Every request must include these credentials to identify your application and authorise your actions. The steps you need to follow can be found in the Authentication page.
Staging Environment
To make development and testing safe and efficient, Thrive provides a staging environment. This lets you:
Build and test integrations before going live.
Validate data models and workflows.
Experiment with new versions safely.
The staging API mirrors production behaviour but uses data from your staging site, ensuring your live environment remains untouched until you’re ready to deploy.
Base URLs for Staging
For all staging endpoints (except User Webhooks): All regions (except MEA) →
https://public.api.learnstaging.link, MEA →https://public.api.meastaging.learn.techThe base URL for the staging User Webhooks service: All regions (except MEA) →
https://user.api.learnstaging.link, MEA →https://user.api.meastaging.learn.tech
Production Environment
Once your integration is tested and validated in staging, you can move to the production environment to interact with live data and users. Both environments use the same versioning, error format, and authentication model, so migration is seamless.
The production environment is where:
All data and user activity are real and persistent.
Rate limits, performance, and security controls are enforced.
Requests require a production API key (different from staging credentials), which must be created using information from your live site.
Base URLs for Production
The base URLs for production endpoints follow the same structure as staging:
For all production endpoints (except User Webhooks): All regions (except MEA) →
https://public.api.learn.link, MEA →https://public.api.mea.learn.techThe base URL for the production User Webhooks service: All regions (except MEA) →
https://user.api.learn.link, MEA →https://user.api.mea.learn.tech
Important:
Only switch to production credentials when you’re confident your integration behaves as expected.
We discourage test calls to production, as they may affect live learning data or analytics.
Developer Experience
The Thrive API is designed for a great developer experience, providing:
Clear, structured endpoints.
Meaningful error messages and HTTP status codes.
Versioning and deprecation policies designed to avoid surprises.
Developer tools and documentation to help you get started quickly.
Next Steps
Read the Authentication page to learn how to generate your API key.
Review our Rate Limits information to understand how this might affect your integration.
Understand our Versioning and Breaking Changes policy, which is supported by our Deprecation and Sunsetting approach.
Consult the Errors and Error Handling page for guidance on handling typical issues.
Make your first API call and then build out the rest of your integration against our staging environment.