Overview of API services and endpoints

Introduction

The Docebo API browser is an interface that helps you explore and interact with the API endpoints available on your platform. This guide walks you through how to use the API browser to verify whether an API exists for a specific action–such as creating users, exporting reports, or managing learning content. Within the API browser, you can see all the services and their related endpoints, checking which operations are supported, what parameters are required, and how to use each endpoint to perform tasks across your platform.

For instructions on how to access the API browser and authenticate, see the article Get started with the Docebo API browser.

Keep in mind:

When using the API Browser, any actions you perform are real and will affect your platform directly. These are not just tests, so be cautious when executing operations.

Introduction to services and endpoints

In the API Browser, actions are grouped into services. A service represents a part of the platform's functionality, like managing users, handling transactions, or processing data.

Each service has endpoints, which are specific URLs you use to perform actions. For example, if you select the manage service, when you expand the Users grouping, you will find endpoints that include:

• GET /manage/v1/user: Retrieves a list of users

• POST /manage/v1/user: Creates a new user

Similarly, if you select the learn service, when you expand the Catalogue grouping, you will find endpoints that include:

• GET /learn/v1/catalog/filters: Retrieve all the filter options for a catalog

The API Browser will guide you through how to use these services, showing you what information (parameters) you need to provide, how to format your requests, and what kind of responses to expect. It will also include authentication details and examples to help you use the API effectively.

API browser services quick reference

The following table provides an overview of where different functionalities are found within each service in the API. This summary helps you quickly find the right service and associated endpoints based on the functionality you need. Note that some functions may be covered by more than one service.

Learn

This service covers both formal and informal learning actions in the platform, including:

• E-learning and vILT courses and sessions, and external training

• Enrollment management for courses and learning plans

• Channels and assets management

• Training materials and assets, such as surveys, tests, forums, and course file repositories

• Subscription bundles

Skill

The endpoints for managing user skills on the platform:

• Skill associations to users, courses, and profiles

• Manager and My Team feature endpoints

• Integration APIs for external talent management systems

Share

Handles informal learning management, including:

• Assets, channels, questions & answers, and experts from Coach & Share

• Gamification features

Manage

Covers overall platform management functions, such as:

• User management, central repository, enrollment rules, background jobs, and mobile app

• Extended Enterprise (multidomain), branch structure, branding configurations

• Global search, cookie policy, privacy, and terms and conditions

Notifications

Contains endpoints related to:

• Notifications and DKIM configuration

E-commerce

Includes:

• Endpoints for transactions, billing information, and e-commerce configurations

Marketplace

The endpoints in this service deal with:

• Marketplace content providers (GO1, LinkedIn Learning, and OpenSesame).
  

  Please note:

  The available endpoints vary depending on the content provider.

Report

Endpoints focus on:

• Dashboard data and retrieving custom reports (legacy reports)

• Query Builders Reports

Pages

Includes endpoints for:

• Menu and page management (create, edit, delete)

OTJ

Handles:

• Observation checklists (managing, uploading, approving, or rejecting)

Audittrail

Includes:

• Endpoints for audit trail queries and logs

Course

The course service endpoints deal with:

• E-learning courses, ILT courses, events, sessions, and thumbnail management

Analytics

Covers:

• Query builder, new custom reports, report dashboards, and manager reports

Audiences

Includes:

• Endpoints for managing groups and users

Poweruser

Includes:

• Endpoints for power user permissions, profiles, and, resources associations

Learningplan

Covers:

• Learning plan management and learning plan enrollment configurations

Enrollment

• Contains endpoints for archived enrollments only

Certification

Handles

• Endpoints for awarded certifications.

Services currently without actionable endpoints in the API browser

• Impact

• Proctoring

• External

• Conference tool

• Messenger

Deprecated categories

• Webinar

Please note:

In the Learn service, most of the webinar endpoints are deprecated or are no longer supported.

Utilizing endpoints

Here follows an overview of how to identify the endpoint you need and understand how to use it.

Locate the service and endpoint

In the API browser, look for the service that contains the action you want to perform (for example, user management, course update). Select the desired service from the Services drop-down list.

Once you are in the right service, still in the left-hand panel, scroll down to find the specific endpoint under the API Reference heading (in this example, Retrieves content of the given catalog). The API URL will be accessible there.

View endpoint details

After selecting the endpoint, in the center panel, you will see the parameters that help refine your request. These parameters might include:

• Required parameters: Information you must provide to run the endpoint successfully

• Optional filters: Options to narrow down the results (for example, filtering by a specific user)

• Result size: You can set how many results per page you want

• Sorting options: Choose how to sort the results (for example, by date or name)

By filling in the right parameters and configurations, you can ensure the endpoint runs smoothly without errors.

View the sample response

On the right-hand panel of the API browser, you will see an example of the endpoint response. This response shows what kind of data you will receive when the endpoint is successfully called. Examples of data types include:

• String: A string is a collection of characters, like words or text. For example: "Hello World".

• Integer: An integer is a number without decimal points. For example: 25 or 100.

The example response helps you understand the format of the data that the endpoint will return, so you know what to expect when making your API requests.

Check the response schema

On the right panel, below the response sample, you will find the response schema. This section provides a detailed definition and explanation of each item included in the response. It breaks down what each field in the response means and what type of data it holds (for example, string or integer).

For example, if the response includes a catalog's details, the schema might explain:

• "id" (string): The catalog ID.

• "name" (string): The catalog name.

• "description" (string): The description of the requested catalog.

This helps you understand the structure and meaning of the data returned by the endpoint.