Overview
Overview
In this article:
- Overview
- What you can do with the API
- Base URL and versioning
- Authentication
- Webhooks
- API reference documentation
- Things to keep in mind
- FAQs
Overview
SuperPath provides teams with the ability to create, assign and track any type of learning content. Complete with pre-made learning templates, SuperPath allows managers to reduce the time to get their team productive, through bespoke learning Pathways.
Explore our guides, concepts and examples to integrate with SuperPath using our public APIs and developer tools.
The SuperPath API is a RESTful API over HTTPS that returns JSON, so you can use the language and platform of your choice to make requests. To get a feel for the API you can also use a tool like Postman or Insomnia.
Before you can call the API you'll need an API key. API keys are a paid-plan feature and are generated inside SuperPath by an Owner or an Admin, under Settings → Integrations. See the help article How to Generate an API Key for the in-app steps, then Learn how to authenticate with the SuperPath API for how to use the key.
What you can do with the API
The API works with the same records your team works with in the app — read them, create them, update them and, where it makes sense, delete them. The reference documentation groups the endpoints into these areas:
Area | What it covers |
|---|---|
Users | Learner and administrator records, their learnings, CPD points, settings and bulk operations |
Teams | Teams, Team hierarchy and Dynamic Team membership |
Content, Pathways and Events | Learning Content, Pathways and Events in your Library |
Assignments | Learning assigned to a user |
Forms | Forms, quizzes and responses |
Roadmaps | Roadmaps, levels and user progress through them |
Knowledge | Knowledge articles |
Certificates | Certificates and the certificates a user has earned |
Skills | Skills and user Skills |
Gamification | Points, badges and leaderboards |
Scheduled Learning | Recurring and scheduled learning |
Announcements | Announcements published to your learners |
Assets and Categories | Uploaded assets and the category taxonomy |
Reports and Analytics | Reporting data and scheduled reports |
Search | Cross-entity search |
Webhooks and Workflows | Webhook registrations and automation workflows |
Integrations | Third-party integrations connected to your account |
Security | API key management |
Tenants | Your account and its settings |
For the exact endpoints, request bodies and response schemas in each area, use the API reference documentation.
Base URL and versioning
The API uses a base path of https://api.superpath.io. There is no version prefix in the path — resource paths sit directly under the base URL:
GET https://api.superpath.io/users GET https://api.superpath.io/teams
As we update and release newer versions of the API, we reserve the right to remove older APIs and functionality with a 3-month deprecation notice.
Authentication
Almost every endpoint requires authentication. You authenticate by sending your API key as a bearer token in the Authorization header:
Authorization: Bearer <your-api-key>A key is tied to the user it was generated for, so a request made with that key can only see and change what that user's role allows — and it always operates inside that user's SuperPath account. Full details, including the error responses you'll get for a missing, malformed or revoked key, are in Learn how to authenticate with the SuperPath API.
Webhooks
The API is for when your app asks SuperPath for something. Webhooks are for the other direction — SuperPath tells your app when something happens, such as a user being created or a learner completing a piece of content.
- Webhooks - Get updates in real-time — how webhook delivery works and how to build an endpoint.
- Types of Events — the events you can subscribe to.
- The Event Object — the shape of the payload we POST to you.
- Webhook Signature Authentication — verifying that a request really came from SuperPath.
Registering, editing and deleting webhook endpoints is done in the app under Settings → Integrations. See the help articles How to Register a Webhook, How to Secure a Webhook with Signature Authentication and How to Edit or Delete a Webhook.
API reference documentation
Detailed API reference documentation, including every endpoint and schema, is at https://superpath.readme.io/reference.
Things to keep in mind
- API access is only available on paid accounts. On a free plan the API keys section in Settings → Integrations points you to your Billing settings to upgrade.
- An API key inherits the permissions of the SuperPath user it was generated for. Generate keys against a user whose role has the access your integration actually needs, and no more.
- A key is shown once when it's generated and can't be retrieved afterwards. Store it securely and revoke it if it's ever exposed — see the help article How to Revoke an API Key.
- Plan for throttling and retries. See Learn about API rate limits and how to work with them and Learn how to handle and recover from errors received from the SuperPath API.
FAQs
Where do I start?
Follow Getting started with SuperPath API — it walks you from account to first authenticated request.
Is there a test environment?
If you need one, contact us at support@superpath.io and we can look at providing a test account for you to use.
How do I sign learners in from my own app?
See Implementing Auto Login (For Customers), or Implementing Auto Login (For Partners) if you're a SuperPath partner.
Updated on: 25/07/2026
Thank you!