Skip to main content

APIs within the learning platform

Available APIs in learning platform

Written by Marie Xhauflair

Every organisation has different needs to connect the platform to their own tools. To accommodate those variations, we built a set of APIs to export your learning platform data as well as import user data.

What is an API?

API stands for Application Programming Interface, a set of codes that allows two applications to communicate with each other. Using an API allows you to import user information from your own user database to automate the user and group management of your platform. Or it allows you to retrieve, analyse, and report platform data in your own data warehouse or business intelligence (BI) tool.

There are two main APIs available on the platform:

    1. Reporting APIs allow you to obtain all the available progression data from the platform.

    1. Web APIs allow you to import, monitor and update user and group data on the platform, and to manage a user's todos.

Other APIs: you can also provision users with SCIM or with the older User Provisioning API v1.


Interactive documentation

Each API has its own interactive documentation on your platform, where you can see every endpoint and try it out with your credentials.

  • Reporting API (v2): https://<platform name>.platform.co.nl/api/v2/public/docs/, for example https://tinqwise.platform.co.nl/api/v2/public/docs/. Read-only endpoints to export progress data on users, groups, activities, journeys, programmes, skills and training time.

  • Web API v3 for user management: https://<platform name>.platform.co.nl/api/v3/public/docs/, for example https://tinqwise.platform.co.nl/api/v3/public/docs/. Endpoints to create and update users, groups, memberships, permissions, activation tokens, budgets and todos.


Web API v3 per endpoint

The user management documentation is split per endpoint. Start with the setup articles, then go to the endpoint you need.


TIP: If you don't know where to get started with APIs, consult to your IT or engineer colleagues 😉

Did this answer your question?