Skip to main content

Docebo Help

How can we help?

Get started with the Docebo API browser

Last updated
Docebo module
Reading time
User level
  • Administrators
  • Power Users

Introduction

The Docebo API browser is available within your platform. 

  • It contains reference  documentation for all of Docebo’s publicly available API endpoints. This documentation is continually updated with the most up-to-date API version. 
  • It is also interactive, which means you can try out API calls on your platform’s data directly from the API browser.  

This article covers how to access your platform’s API browser, authenticate, and get started working with the different endpoints.

Access the API browser

The access link to the API reference documentation is obtained by appending /api-browser to your platform URL. For example:

https://<yourcompany>.docebosaas.com/api-browser/

or

https://<your custom domain>/api-browser/

The available microservices are listed in the SERVICES combobox. When you select a new microservice, the documentation for that specific service is automatically loaded. 

Tip: For more information about the different microservices and endpoints check out the article Overview of API services and endpoints.

View the reference documentation for an endpoint

In the navigation panel on the left:

  1. Select the desired microservice from the SERVICES list (for example, Course) to load its documentation.
  2. Then under API REFERENCE click on one of the groupings of that service (for example, Categories) to expand the list of its endpoints.
  3. Finally, click on a specific endpoint to jump to its documentation.

For the selected endpoint, in the right-hand panel you will see a Response sample and also a Body sample if applicable. You can click the Body schema or Response schema headings to expand the detailed documentation of all the parameters.

In the center panel there is an area where you can interactively test the endpoint by trying out a call on your platform’s data. However, to do this you must first obtain a token as described in the following paragraph.

Obtain an API access token

To make calls from the API browser, you will need an OAuth2 access token that is linked to your platform credentials, as a Superadmin, Power User, or normal user.

Please note: Docebo leverages OAuth scopes and grants to allow access to the API, so the endpoints are following a role-based access model by default. The permissions you have on the platform will determine the resources and actions you can access via API calls using this access token. 

To get started, log in to the platform. You can also not log in at this stage, in which case you’ll have to enter your platform credentials later.

  1. Now access the API browser page and, for any endpoint, in the center panel click the Oauth button.
  2. In the dialog box that opens click Authorize. (It is not necessary to click on the api scope)
  3. Now in the Authorization required dialog you will be welcomed as whatever user you previously logged in as: here click Authorize again.

    Note: If you did not previously log in to the platform, you will be prompted to enter your credentials before you can click Authorize.
  4. Now you are redirected back to the api browser page where you can see that you are signed in (the Oauth button now says Signout):

    Also the Token field is now populated:

Now you can begin making API calls on your platform’s data. 

Note: In the Token field you can also directly paste a previously generated OAuth2 access token

Test an endpoint in the API browser

Once you have provided an access token in the API browser, you can try out calls to the endpoints. To do this, in the API browser navigation panel select the endpoint as before, then in the middle panel click the Try button.

A window will open where you can examine the real response of your platform to this API call:

Caution: The API calls you make here will operate on the real data of your platform, so be cautious making calls (DELETE, POST, etc) that can change or delete data.

Next steps

To continue learning about how to use your API browser, including how to handle calls that require parameters, move on to the article Send your first requests using the API browser.