Skip to main content
Klaxoon Help Center home page

What can we help you with?

Search

What can Klaxoon APIs do?

Written by Klaxoon.
Updated

​

Klaxoon APIs allow you to integrate Klaxoon with your applications and services, and automate many processes around visual collaboration. You can connect your business tools to Klaxoon Board to exchange data, create personalized workflows and optimize your information management.

1 - Board API

The Board API allows you to interact programmatically with Klaxoon Boards. You can:

  • Create a Board from an external application.

  • List and retrieve the available boards for a user.

  • Retrieve detailed information about a Board (title, description, author, status, etc.).

  • Add, modify or retrieve ideas on a Board (position, content, color, category, dimension...).

  • Manage the categories, colors and dimensions of a Board to visually organize ideas.

  • Automate the management of participants and rights (based on Host or Participant roles).

2 - Activity Picker & Klaxoon Embed

  • Activity Picker: allows you to integrate a Klaxoon activity picker into your tools to facilitate access or invitation to sessions.

  • Klaxoon Embed: integrate Klaxoon Boards or activities directly into other applications via an embedded link.

3 - Audit Logs API (for companies)

  • Allows you to extract activity logs for monitoring and compliance.

4 - SCIM API (for companies)

  • Automates user lifecycle management (creation, modification, deletion) via the SCIM protocol.

5- Participant Activity Report API

  • Allows you to generate participant activity reports on the Boards, to analyze engagement and participation.

Examples of concrete uses

  • Automatically create a Board when creating a project in your business tool.

  • Add ideas to a Board from a third-party application (e.g. turn a support ticket into a post-it note on Klaxoon).

  • Synchronize data between Klaxoon and your reporting or BI tools.

  • Extract activity reports to measure participation in workshops.

How to use Klaxoon APIs?

  1. Register your application on the Klaxoon developer platform.

  2. Implement OAuth 2 to allow users to allow your app to access their Boards.

  3. Check out the official documentation to learn about all endpoints and use cases: developers.klaxoon.com

Good to know

  • The access rights to the Boards depend on the user's role (Host or Participant).

  • Some APIs are reserved for Enterprise plans (Audit Logs, SCIM).

For questions or to get started with Klaxoon APIs, see the developer documentation.