Recommend courses

GET/v1/organization/{orgId}/learning/workspace/engagement/recommend

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

The next courses for an event's people (eventId) or for named people (emails): up to two per person with the reason for each, and the courses most of them would take. Reads only; nothing is sent. Sending recommendations is a Keep learning campaign. Requires read:learning; refused for a key restricted to particular events. Also at GET /v1/learning/workspace/engagement/recommend.

Request example

cURL

curl --request GET \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/engagement/recommend' \
  --header 'x-access-token: <api-token>'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/engagement/recommend', {
  method: 'GET',
  headers: {
    "x-access-token": "<api-token>"
  },
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/engagement/recommend",
    headers={
        "x-access-token": "<api-token>"
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/engagement/recommend",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/engagement/recommend", nil)
  req.Header.Add("x-access-token", "<api-token>")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/engagement/recommend"))
    .header("x-access-token", "<api-token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters

orgId*

Query parameters

eventId

emails

limit

GET

Send request

Authorizations

• x-access-tokenstringheader

  Organization API token. Generate from Organization Settings → API Tokens.

• AuthorizationBearer <token>headeror

  OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

• orgIdstringpathrequired

  Your organization ID. Any other organization returns 404.

Query parameters

• eventIdintegerquery

  The event whose people to recommend for. Takes precedence over emails.

  Minimum

  1

• emailsstringquery

  Comma-separated emails. The first 200 are read.

  Max length

  8000

• limitintegerquery

  People returned.

  Default

  50

  Minimum

  1

  Maximum

  200

Responses

200application/json

OK

• successboolean
• payloadLearningCourseRecommendations
  Show child attributes

  • eventLearningEventRef | any | null
    Show child attributes

    • idinteger
    • namestring
  • peopleobject[]

    People with at least one course to take next.

    Show child attributes

    • person_idstring<uuid> | null
    • namestring
    • emailstring
    • picksLearningNextLesson[]

      Max items

      2

      Show child attributes

      • lesson_idstring<uuid>
      • content_idstring
      • titlestring
      • kindstring
      • minutesinteger | null
      • creditobject[]
        Show child attributes

        • type_idstring<uuid> | null
        • namestring | null
        • amountnumber
      • eventstring | null
      • sessionstring | null
      • reasonstring

        Allowed values

        "renewal", "continue", "attended", "topic", "credit", "popular"

      • becausestring
      • rankinteger
      • earns_creditboolean

        attended only.

  • coursesobject[]

    Courses picked, by how many people they suit.

    Show child attributes

    • lesson_idstring<uuid>
    • titlestring
    • peopleinteger
  • summarystring

400application/json

A path, query or body value failed validation, or an unknown body property was sent. message names the field. (A source object naming the assistant, with the person's prompt, is accepted on every write and removed before validation.) For an {eventId} path that is not a whole number: error: VALIDATION_ERROR, eventId must be a valid integer.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

• errorstring | object

  The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

• messagestring
• statusinteger
• successboolean
• namestring
• codestring

  FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

• featurestring
• paused_atstring<date-time>

401

Missing, invalid or expired token.

403application/json

• SCOPE_REQUIRED — the token lacks read:learning (reads) or write:learning (writes). Legacy tokens with no scopes cannot write.
• ORG_WIDE_TOKEN_REQUIRED — the token is restricted to particular events: "The Learning workspace covers every event and learner in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
• FEATURE_NOT_ENABLED (feature: lessons_credits) — Learning is not on for the organization.
• FORBIDDEN — the token's user is not an active member of the organization, or lacks the Lessons permission the operation needs.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

• errorstring | object

  The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

• messagestring
• statusinteger
• successboolean
• namestring
• codestring

  FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

• featurestring
• paused_atstring<date-time>

404application/json

The event is not in your organization (Event could not be found), or another organization.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

• errorstring | object

  The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

• messagestring
• statusinteger
• successboolean
• namestring
• codestring

  FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

• featurestring
• paused_atstring<date-time>

429application/json

• The token's request limit (100 requests per 15 minutes per bucket by default — see Rate Limiting). Wait Retry-After seconds.
• QUOTA_EXCEEDED (writes) — the token's daily write quota (10,000 a day). Resets at midnight UTC.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

• errorstring | object

  The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

• messagestring
• statusinteger
• successboolean
• namestring
• codestring

  FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

• featurestring
• paused_atstring<date-time>

• Retry-Afterintegerheader

  Seconds to wait before retrying.

Response examples

200

{
  "success": true,
  "payload": {
    "event": {
      "id": 123,
      "name": "<string>"
    },
    "people": [
      {
        "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "picks": [
          {
            "lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "content_id": "<string>",
            "title": "<string>",
            "kind": "course",
            "minutes": 123,
            "credit": [
              {
                "type_id": null,
                "name": null,
                "amount": null
              }
            ],
            "event": "<string>",
            "session": "<string>",
            "reason": "renewal",
            "because": "<string>",
            "rank": 123,
            "earns_credit": true
          }
        ]
      }
    ],
    "courses": [
      {
        "lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "people": 123
      }
    ],
    "summary": "<string>"
  }
}

400

{
  "error": "<string>",
  "message": "<string>",
  "status": 123,
  "success": true,
  "name": "<string>",
  "code": "<string>",
  "feature": "<string>",
  "paused_at": "2026-01-15T09:30:00Z"
}

403 · Event-restricted key

{
  "error": "ORG_WIDE_TOKEN_REQUIRED",
  "message": "The Learning workspace covers every event and learner in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
}

403 · Token lacks the write scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This operation requires the 'write:learning' scope."
}

403 · Learning is off

{
  "status": 403,
  "success": false,
  "message": "Feature 'lessons_credits' is not enabled for this organization",
  "name": "FeatureNotEnabledError",
  "code": "FEATURE_NOT_ENABLED",
  "feature": "lessons_credits"
}

404

{
  "error": "<string>",
  "message": "<string>",
  "status": 123,
  "success": true,
  "name": "<string>",
  "code": "<string>",
  "feature": "<string>",
  "paused_at": "2026-01-15T09:30:00Z"
}

429

{
  "error": "<string>",
  "message": "<string>",
  "status": 123,
  "success": true,
  "name": "<string>",
  "code": "<string>",
  "feature": "<string>",
  "paused_at": "2026-01-15T09:30:00Z"
}