API changelog

View as Markdown

In short

All changes to the Continuum Learn API, newest first. Additive changes appear here when they ship; deprecations are announced here at least 12 months before anything stops working.

Changes are listed newest first. See Versioning and deprecation for what counts as a breaking change and how much notice we give.

12 November 2026: amounts are in the order's currency

Amounts are in the order's currency, which may not be GBP; event products now state their currency. Nothing was removed or renamed, and a team selling in pounds sees no difference.

  • Orders, invoices and webhooks. Every money field on an order, invoice, credit note and on the order.completed, order.refunded, invoice.issued and credit_note.issued webhooks is a decimal string in that document's currency. Read currency instead of assuming pounds.
  • Event products. Each product in an event's products array, and the event's price object, now carry currency, an ISO 4217 code. Course prices already did.

10 November 2026: recurring training

Courses can now carry a recurring training requirement: learners complete the course and renew it on a schedule. This changes what existing API v2 reads and events mean on those courses. Nothing changes for a course without a requirement, and no field was added, renamed or removed.

  • Progress is per cycle. GET /users/{user}/progress/{course} and the other progress endpoints describe the learner's current cycle. When a renewal opens, the earlier cycle is archived and the learner drops back to not_started, with quiz attempts and sign-off reset.
  • Webhooks fire once per cycle. course.completed and certificate.issued are sent each time a learner completes a renewal, and each cycle's certificate is a new one that supersedes the last.
  • Enrolment events cover required enrolments. enrolment.created and enrolment.removed are sent when a requirement enrols a learner or releases a required enrolment. Activating a requirement on a large audience therefore sends many enrolment.created events in the background.
  • A new error on removal. DELETE /users/{user}/enrolments/{course} returns 409 with error.code required_training while an active requirement covers the user on that course. The code is listed in errors. Clients should already treat an unknown 409 code as a conflict (see Versioning).

Unreleased: API v2

API v2 is the first documented, versioned Continuum Learn API. These entries will be dated when it is released.

Foundations

  • Named, revocable API keys per team, stored as hashes, each limited to the scopes you choose, with an optional expiry date. Created in Settings > Website & API > API keys.
  • Authorization: Bearer authentication (X-API-Key also accepted).
  • One error envelope for every error, with a stable error.type and error.code, and a request_id.
  • Cursor pagination on every list.
  • Published rate limits (300 a minute per key, 600 a minute per IP address) with X-RateLimit-* and Retry-After headers.
  • Idempotency-Key support on every POST.
  • X-Request-Id on every response.
  • Catalogue prices show what the buyer pays: price.display (courses) and price.display / price_display (events) include VAT, matching the cart. Courses gain price.amount_including_tax and event prices and tickets gain amount_including_tax (pence); price.amount stays the net price in pence.
  • Gross prices use each product's own VAT rate and the team's VAT settings (zero-rated products and teams that are not VAT registered show gross = net), and price objects gain tax_rate (the VAT percentage applied).
  • An OpenAPI 3.1 specification at /developers/openapi.json, and this documentation.

Endpoints

  • GET /me
  • Catalogue: GET /courses, GET /courses/{id} (with the module and lesson outline), GET /course-folders, GET /events, GET /events/{id}.
  • Users: list and search by email or external id, create, update, deactivate, reactivate and remove.
  • Custom fields: GET /custom-fields lists the team's sign-up fields and their options, for use in custom_fields.
  • Groups: create, update, delete, members one at a time or in bulk, and assigning a group to a course.
  • Enrolments: enrol by user id, email or external id, remove, and list by user or by course.
  • Progress: by user and course, across a user's courses, and for everyone on a course, with quiz results, attendance, sign-off and certificate.
  • Credentials: GET /credentials and GET /credentials/{certificate_number} for issued course and programme certificates, with the signed credential.

Also new

  • Outbound webhooks for user.created, user.removed, enrolment.created, enrolment.removed, course.completed, certificate.issued and order.completed, signed to the Standard Webhooks specification, with retries for about 27 hours, a delivery log, redelivery and secret rotation. Managed in Settings > Website & API or through /webhook-endpoints.
  • New order.refunded webhook event, sent when a refund of an order succeeds: order (same shape as order.completed), refund (id, amount, full, created_at) and user.
  • order.completed gains order.subtotal, order.discount, order.tax, order.coupon ({ "code" } or null) and, on each item, quantity and unit_price. Existing keys are unchanged.
  • New invoice.issued and credit_note.issued webhook events, sent when an invoice (or receipt) or a credit note is issued, each with the document's number, dates, currency and totals plus the user.
  • order.completed (and order.refunded) gain order.invoice_number (or null) and, on each item, tax_rate. Existing keys are unchanged.
  • Orders: scope orders:read, GET /orders, GET /orders/{id}, GET /invoices/{number} and GET /invoices/{number}/pdf.
  • Sign-in links: POST /users/{id}/sign-in-links creates a single-use link, valid for up to five minutes, that signs a learner in from your own system.

API v1

v1 (/api/v1, authenticated with the team key) is frozen. It keeps working for existing integrations, including the WordPress plugin, and receives security fixes only. In November 2026 it was hardened without changing any field a client reads: the course list now returns a fixed set of fields instead of every database column, and the registration endpoint no longer returns internal error details.

Building an integration?

Tell us what you are connecting and we will help you plan it, or book a demo to see the API working.