Skip to main content

Introduction to Claned External REST API

In this article we will introduce you to how our API works, common use cases, the Entra/AAD integration, and guide you to our documentation.

Updated this week

1. The Claned External API

The Claned External API is a REST API that allows you to connect Claned to your existing systems and workflows. It supports both importing data into Claned (e.g. inviting users, assigning access) and exporting data out of Claned (e.g. course completions, grades, login activity).

To authenticate, you will need an API key. You can retrieve this from the Claned admin panel under Advanced settings.

Key characteristics:

  • REST API with JSON and CSV response formats

  • Supports both data import and export

  • Interactive Swagger documentation available for all instances — great for exploring endpoints and testing calls without writing any code

  • Can be integrated with almost any system that is capable of making HTTP requests

The API base URL depends on your organization's instance (*.claned.com).

Make sure to use the correct base URL for all API calls. If you are unsure which instance your organization is in, please contact [email protected].

2. What can you do with the API?

Common use cases

Inviting users — add new or existing users to your Claned organization or a specific group, with optional access expiry and external identifiers for tracking.

Getting course results — retrieve grade results, completion states, and progress data per board (course). Supports filtering by user, date range, and output format (JSON or CSV).

Exporting analytics data — export event-level data such as login history, content progress, and assessment scores. Useful for reporting pipelines and BI tool integrations.

Receiving real-time events via webhooks — get notified automatically when key events occur in Claned, such as a data export completing or a board grade being issued. See the [LINK: Webhooks article] for setup details.

Other capabilities

  • Add or remove user roles and access rights

  • Remove users from the organization

  • Copy boards

  • Manage groups and group membership

3. Entra ID / Azure Active Directory integration

Claned has a ready-made integration for both authentication and authorization with Entra ID (formerly Azure Active Directory):

  • Authentication: users can log in using their Office 365 accounts, and are automatically added to your Claned organization on first login.

  • Authorization: Claned can sync group memberships from your Entra ID tenant in real-time, so you only need to maintain user-group assignments in one place.

On-premise Active Directory solutions need to be assessed case by case — contact [email protected] to discuss.

4. Example external API integration use cases

  • An insurance organization connected their Dynamics CRM to automatically invite both internal staff and customers to Claned training boards.

  • A training company integrated their trainer portal to provision and log in users automatically, without requiring manual credential entry.

  • A governmental training organization connected their WooCommerce webshop to automatically invite users to Claned after purchase.

  • A healthcare organization integrated their Sympa HR system to both invite users and push course completion records back into the HR system.

5. Getting started

The best place to start is the interactive Swagger documentation for your instance (links above). You can use Swagger directly in your browser, or use tools like Postman or cURL to make API calls.

If you have questions or need help getting started, contact us at [email protected].

Did this answer your question?