How to create and manage API keys

In short

In Continuum Learn, team admins create API keys in Settings > Website & API > API keys. Each key has a name, the scopes you tick and an optional expiry date. It is shown once, and you can revoke it at any time.

Still deciding? See what LMS API in Continuum Learn can do for your organisation.

An API key lets another system, such as your membership database, intranet or website, work with your Continuum Learn team through the Continuum Learn API. Your developer or supplier will usually ask you for one. This guide is for the admin who creates it.

Who can do this: team admins. API keys are on Settings > Website & API.

Before you start

Ask whoever is building the integration two things:

  • What it is for, so you can name the key after it, for example "Membership system sync".
  • Which scopes it needs. A scope is one kind of access, such as reading courses or enrolling learners. Give a key only the scopes it needs. The developer documentation lists which scope each part of the API needs.

Plan one key per system. Then if you stop using one system, you can revoke its key without breaking the others.

Create a key

  1. Go to Settings > Website & API.
  2. In the API keys card, click Create API key.
  3. Enter a Name that says what will use the key.
  4. Under Scopes, tick each kind of access the key needs (see the table below).
  5. Optionally, set an Expiry date. The key stops working at the end of that day. Use this for a short project or a contractor.
  6. Click Create key.
  7. The key is shown once, in the Your new API key window. Click Copy and pass it to your developer through a secure route, such as your password manager. Don't send it in an ordinary email or chat message.
  8. Click I've copied it.

You won't see the key again: Continuum keeps only a scrambled version (a hash) that can check a key but can't show it. If the key is lost, revoke it and create another.

Scopes

Scope Gives access to
catalogue:read Read the course and event catalogue, including private courses
users:read Read users, your sign-up fields, groups and group members
users:write Create and update users, and deactivate or remove them from the team
groups:write Create, update and delete groups and their members
enrolments:read Read who is enrolled on what
enrolments:write Enrol people on courses and remove enrolments
progress:read Read learners' progress, quiz results, attendance and certificates
webhooks:manage Set up webhooks that send events to another system
auth:sign_in_links Create one-time links that sign a learner in from another system
credentials:read Read the credentials (certificates and badges) you have issued
orders:read Read completed orders, invoices and credit notes

A few things to know before you tick the write scopes:

  • Enrolling through the API takes no payment and skips approval. A system with enrolments:write can enrol people on paid courses, and on courses that need approval, straight away.
  • The API never makes anyone an admin. People it creates are always learners, and it can't change admins, owners, billing contacts or authors, or anyone who also belongs to another Continuum team.
  • Sign-in links are powerful. A key with auth:sign_in_links can sign learners in. Only give it to a system that already checks who people are.

See and revoke keys

The API keys card lists every key with its name, the first characters of the key (so you can tell keys apart), its scopes, when it was created, when it was last used and its status: active, expired or revoked.

To revoke a key, click Revoke next to it. It stops working straight away, and whatever uses it gets an "authentication" error on its next request. Revoking can't be undone; create a new key if you need one.

You can't change a key's scopes after creating it. To change them, create a new key with the right scopes, have your developer switch to it, then revoke the old one.

The older team API key (v1)

Below API keys is the Team API key (v1, legacy) card. This single shared key is used by the WordPress plugin and by integrations built before API keys existed. It doesn't work with the current API (v2), and new integrations should use a key from the API keys card instead.

Clicking Rotate API Key replaces the legacy key immediately, which disconnects any WordPress site or integration still using it until it is updated. Sites connected to the WordPress plugin with their own credentials are not affected. See How to connect a WordPress site to Continuum Learn.

Keeping keys safe

  • Treat a key like a password: anyone who has it can do what its scopes allow.
  • Keys belong on servers. They should never be put in a web page, a mobile app or a shared document.
  • Revoke a key as soon as the system or person using it no longer needs it, or if you think it may have leaked.
  • Check Last used from time to time. A key that hasn't been used for months is probably safe to revoke.

Frequently asked questions

Does the API cost extra?

No. The API is included on every Continuum Learn plan.

Can a key see other teams?

No. A key belongs to one team and can only ever see that team's courses, people and progress.

Our developer says they get "permission_error". What does that mean?

The key doesn't have the scope that part of the API needs. Create a new key with the extra scope, then revoke the old one.

Where is the technical documentation?

In the developer documentation, starting with Getting started. It includes an API reference your developer can import into tools such as Postman.

More guides

  • Build your first courseCreate a course, add modules and lessons, lay out content with rows and columns, preview it as a learner and make it available to your learners.
  • ProgrammesGroup courses into a programme, choose which are required or optional, and award one certificate automatically when a learner completes the set.
  • Content blocksA reference of every content block you can add to a lesson in the course editor, what each one does, and the settings you can change.
  • Learning pathsPut a programme's courses in order so each one opens only when the one before it is complete, let learners see the whole path from day one, and sell or assign it as one thing.
  • SurveysBuild a survey once, place it inside any lesson or ask it when a learner finishes a course, then read the results and export them to CSV.
  • Course settingsEvery tab and field in the course settings panel, from title and the course page to access, learner tools, certificates, scheduling, topics, languages and selling.
  • CertificatesDesign certificate templates, switch certificates on for a course, print CPD hours and expiry dates, and let anyone verify a certificate online.
  • Quizzes and knowledge checksAdd a graded quiz to a lesson, write multiple-choice questions, set the pass mark and retakes, draw from question banks and see learner results.
  • Digital badgesGive learners a digitally signed Open Badges 3.0 credential for a course or programme that they can share on LinkedIn and employers can verify in one click.
  • Quiz answers and explanationsWrite an explanation for each quiz question and choose whether learners can review their answers, the correct answers and your explanations after an attempt.
  • Presenters and discussionAdd presenter profiles to your courses, give presenters their own area, and let learners ask questions on a moderated course discussion board.
  • Course stylesChoose a look, accent colour, fonts, dividers and navigation style for a course, and set the text colours used over coloured rows and columns.
  • Using your digital badgeAdd your digital badge to LinkedIn, put the verification link on your CV, use it as CPD evidence for appraisal or revalidation, and keep it in a badge wallet.
  • Present (presenter area)Follow learners, check results, confirm attendance, sign off learners and answer questions, as a presenter, admin or author.
  • Live eventsCreate a live event, stream to it from OBS or your browser, sell access and let learners watch the replay afterwards.
  • Zoom sessionsConnect your Zoom account, add a Zoom session to a lesson, and track who joined or attended so the lesson completes automatically.
  • Live lessonsAdd a Live Lesson block to a course, go live from your browser or OBS, and let learners watch, chat and complete the lesson.
  • AI tutor for learnersLet enrolled learners ask questions about a course and get short answers written only from that course's lesson text, with links to the lessons the answer came from.
  • LanguagesTurn on extra languages, translate your courses with AI or by hand, and translate the text you write yourself, so each learner sees Continuum in their own language.
  • Build with AITurn a topic or your own documents into a draft course, review the outline, and edit the result. Also covers AI quizzes, images, JSON import and your AI allowance.
  • Choosing a website routeCompare the four ways to show Continuum on your own website (catalogue embed, publication embed, WordPress plugin and API) and pick the one that fits.
  • Website embedsUse the Website embeds generator to put live course cards, events, buy buttons or a whole publication on Wix, Squarespace, Webflow, WordPress or any website.
  • Publications on your websiteTurn a guide, handbook or fact sheet into a Publication, then show it on your own website with a copy-and-paste embed, through the API or in WordPress.
  • Translate a courseAdd a language to a course, translate it with AI, check and correct the text, keep it up to date, and see what learners get.
  • WordPressInstall the Continuum Connect plugin, show your courses and events on WordPress pages, add buy buttons and let members sign in once.
  • SCORM exportExport any course as a SCORM 1.2 or 2004 package to run in another LMS, with completion, scores and resume reported back to that LMS.
  • SSO and 2FAConnect your organisation's identity provider over OpenID Connect, decide who must use it, and set two-factor rules for each role.
  • SellingConnect your Stripe account, price courses, build bundles, set your terms of sale, and manage orders and refunds from one place.
  • Selling currencyChoose the one currency your portal sells in, what changes when you switch, what your buyers see, and how payouts and tax work for sellers outside the UK.
  • ReportingFind the right report for your question, filter it, understand every column and export it to CSV, from course progress to quiz, survey and programme results.
  • Branding and domainAdd your logo and colours, set up your header and footer, choose a courses or video focus, and point your own web address at your learning site.
  • WebhooksAdd a webhook endpoint so Continuum Learn tells your membership system or CRM when someone joins, enrols, completes a course, gets a certificate or places an order, then test it, read the delivery log and redeliver.
  • Groups and cohortsLearn the difference between groups and cohorts, then use groups to assign courses and cohorts to build saved lists for notifications and CSV exports.
  • Recurring trainingMake learners complete a course and then repeat it every year or on a fixed date, chase them with reminders, escalate to line managers, and see who is compliant in one matrix.
  • My team (line managers)See how the people who report to you are getting on, check their course results, certificates and required training, and send them a reminder.

Want to see it working on your own courses?

Book a short demo and we will walk you through it.