API essentials - Retrieving IDs

This script is ideal for modern web applications or Node.js environments. It authenticates using your access token and logs a list showing each course's name and ID.

/**
 * Script to retrieve all Course IDs from Docebo
 * Replace <yoursubdomain> and YOUR_ACCESS_TOKEN with your actual data
 */

const domain = "<yoursubdomain>.docebosaas.com";
const token = "YOUR_ACCESS_TOKEN";

async function getCourseIds() {
    try {
        const response = await fetch(`https://${domain}/learn/v1/courses`, {
            method: 'GET',
            headers: {
                'Authorization': `Bearer ${token}`,
                'Accept': 'application/json'
            }
        });

        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }

        const result = await response.json();
        
        // Iterate through items to extract course names and IDs
        result.data.items.forEach(course => {
            console.log(`Course Name: ${course.course_name} | ID: ${course.id_course}`);
        });
    } catch (error) {
        console.error('Error fetching courses:', error);
    }
}

getCourseIds();

Python is the standard for automation and data migration tasks. This script extracts and prints a clean list of IDs and their associated course names.

import requests

# Configuration variables
DOMAIN = "<yoursubdomain>.docebosaas.com"
TOKEN = "YOUR_ACCESS_TOKEN"

# Endpoint URL
url = f"https://{DOMAIN}/learn/v1/courses"

# Headers including authentication
headers = {
    "Authorization": f"Bearer {TOKEN}",
    "Accept": "application/json"
}

def retrieve_course_ids():
    try:
        # Perform the GET request
        response = requests.get(url, headers=headers)
        
        # Raise an exception for any HTTP error statuses
        response.raise_for_status()
        
        data = response.json()
        
        # Parse the course items from the response data
        courses = data.get('data', {}).get('items', [])
        
        print("--- List of Courses ---")
        for course in courses:
            course_name = course.get('course_name')
            course_id = course.get('id_course')
            print(f"ID: {course_id} | Name: {course_name}")
            
    except requests.exceptions.RequestException as e:
        print(f"An error occurred: {e}")

if __name__ == "__main__":
    retrieve_course_ids()

Many enterprise systems use PHP for platform integrations. This script uses the native cURL library to fetch and display course information.

<?php
/**
 * PHP script to retrieve Course IDs from Docebo
 */

$domain = "<yoursubdomain>.docebosaas.com";
$token = "YOUR_ACCESS_TOKEN";

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://$domain/learn/v1/courses",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
        "Accept: application/json"
    ],
]);

$response = curl_exec($ch);
$err = curl_error($ch);
curl_close($ch);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    $result = json_decode($response, true);
    
    // Check if the request was successful and data exists
    if (isset($result['data']['items'])) {
        foreach ($result['data']['items'] as $course) {
            echo "Course ID: " . $course['id_course'] . " | Name: " . $course['course_name'] . "\n";
        }
    } else {
        echo "No courses found or error in response.";
    }
}
?>

Postman is recommended for manually testing and browsing dynamically generated JSON data.

1. Create Request: Open a new tab and set the method to GET.

2. Enter URL: Paste https://<yoursubdomain>.docebosaas.com/learn/v1/courses replacing <yoursubdomain> with your platform’s actual subdomain.

3. Configure Authorization:

   1. Click the Auth tab.

   2. Select Bearer Token from the Type dropdown.

   3. Paste YOUR_ACCESS_TOKEN in the Token field.

4. Action: Click Send.

5. Review Output: The response body will contain an array of items. Look for the id_course field in each object to find the IDs you need.

This script is ideal for modern web applications or Node.js environments. It authenticates using your access token and logs a list showing each course's name and ID.

/**
 * DOCEBO API CHAINING EXAMPLE
 * Logic: Fetch List -> Extract ID -> Fetch Detail
 */

const domain = "<yoursubdomain>.docebosaas.com";
const token = "YOUR_ACCESS_TOKEN";

async function fetchCatalogData() {
    const headers = {
        'Authorization': `Bearer ${token}`,
        'Accept': 'application/json'
    };

    try {
        // --- STEP 1: Fetch the list of catalogs ---
        console.log("Requesting catalog list...");
        const listResponse = await fetch(`https://${domain}/learn/v1/catalog_content/internal/preview?page_size=1`, { headers });
        
        const listJson = await listResponse.json();

        // --- STEP 2: Extract the specific ID ---
        // We use optional chaining (?.) to prevent the script from crashing if data is missing
        const catalogId = listJson.data?.items[0]?.extra_data?.id_catalog;

        if (!catalogId) {
            console.error("No Catalog ID found.");
            return;
        }

        console.log(`Found ID ${catalogId}. Requesting full details...`);

        // --- STEP 3: Use the ID to get more info ---
        // We inject the catalogId variable into the string using backticks ``
        const detailResponse = await fetch(`https://${domain}/learn/v1/catalog_content/internal/${catalogId}`, { headers });
        const detailJson = await detailResponse.json();

        // Log the final result to the console
        console.log("Full Catalog Details:", detailJson);

    } catch (error) {
        console.error("An error occurred during the API chain:", error);
    }
}

fetchCatalogData();

Python is the standard for automation and data migration tasks. This script extracts and prints a clean list of IDs and their associated course names.

import requests
import json

# ==============================================================================
# CONFIGURATION
# Set up your platform domain and the security token you generated.
# ==============================================================================
DOMAIN = "<yoursubdomain>.docebosaas.com"
TOKEN = "YOUR_ACCESS_TOKEN"

# Standard headers required for Docebo API calls
headers = {
    "Authorization": f"Bearer {TOKEN}",
    "Content-Type": "application/json"
}

def get_catalog_workflow():
    # --- STEP 1: Get the list of catalogs ---
    # We use a 'preview' endpoint which gives us a high-level list.
    list_url = f"https://{DOMAIN}/learn/v1/catalog_content/internal/preview"
    params = {"page_size": 1} # We only need the first one
    
    response = requests.get(list_url, headers=headers, params=params)
    
    # Check if the call was successful (Status Code 200)
    if response.status_code != 200:
        print(f"Failed to fetch list: {response.status_code}")
        return

    # Convert the raw response text into a Python Dictionary
    data = response.json()

    # --- STEP 2: Drill down into the Data ---
    # We navigate: data -> items list -> first index [0] -> extra_data -> id_catalog
    try:
        catalog_id = data['data']['items'][0]['extra_data']['id_catalog']
        print(f"Found Catalog ID: {catalog_id}")
    except (KeyError, IndexError):
        print("Could not find a Catalog ID in the response.")
        return

    # --- STEP 3: Get specific details using the ID ---
    # Now we build a NEW URL using the ID we just grabbed.
    detail_url = f"https://{DOMAIN}/learn/v1/catalog_content/internal/{catalog_id}"
    
    detail_response = requests.get(detail_url, headers=headers)
    
    # Print the final result in a pretty format
    print(json.dumps(detail_response.json(), indent=4))

if __name__ == "__main__":
    get_catalog_workflow()

Many enterprise systems use PHP for platform integrations. This script uses the native cURL library to fetch and display course information.

<?php
/**
 * DOCEBO API: Automated ID Retrieval and Chaining
 */

$domain = "<yoursubdomain>.docebosaas.com";
$token = "YOUR_ACCESS_TOKEN";

// --- STEP 1: Setup the initial call to get the list ---
$ch = curl_init("https://$domain/learn/v1/catalog_content/internal/preview?page_size=1");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $token",
    "Accept: application/json"
]);

$listResponse = curl_exec($ch);
$listData = json_decode($listResponse, true);

// --- STEP 2: Extract the Catalog ID ---
// We navigate the array: data -> items -> first element -> extra_data -> id_catalog
$catalogId = $listData['data']['items'][0]['extra_data']['id_catalog'];

if ($catalogId) {
    echo "Found Catalog ID: " . $catalogId . "\n";

    // --- STEP 3: Reuse the cURL handle for the second call ---
    // We update the URL to include the ID we just found
    curl_setopt($ch, CURLOPT_URL, "https://$domain/learn/v1/catalog_content/internal/$catalogId");
    
    $detailResponse = curl_exec($ch);
    
    // Output the final JSON result
    echo $detailResponse;
} else {
    echo "Error: Could not find a Catalog ID.";
}

curl_close($ch);
?>

Postman is recommended for manually testing and browsing dynamically generated JSON data.

This example uses variables to pass data between requests automatically.

1. Request A (The Fetcher):

   1. Set Method to GET.

   2. URL: https://{{domain}}/learn/v1/catalog_content/internal/preview?page_size=1.

   3. Click the Tests tab and paste this script:
      

      // Parse the response into a variable
      var jsonData = pm.response.json();
      // Extract the ID
      var catalogId = jsonData.data.items[0].extra_data.id_catalog;
      // Save the ID into the environment so the next request can see it
      pm.environment.set("active_catalog_id", catalogId);
      console.log("Saved Catalog ID: " + catalogId);

2. Request B (The Receiver):

   1. Set Method to GET.

   2. URL: https://{{domain}}/learn/v1/catalog_content/internal/{{active_catalog_id}}.

   3. Because you used {{active_catalog_id}}, Postman will automatically fill in the ID that Request A just saved.