Get a course and its learners

GET/v1/organization/{orgId}/learning/workspace/courses/{lessonId}

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

One course as the course list shows it (source, credit, learners, completions) plus its number of steps that count, and up to 200 of the people taking it, most recent activity first, each with steps done, percent and whether they completed it. Reads only. Requires read:learning; refused for a key restricted to particular events. Also at GET /v1/learning/workspace/courses/{lessonId}.

Request example

cURL

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

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/courses/{lessonId}', {
  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/courses/{lessonId}",
    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/courses/{lessonId}",
    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/courses/{lessonId}", 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/courses/{lessonId}"))
    .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*

lessonId*

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.

• lessonIdstring<uuid>pathrequired

  The course id (from List courses and course drafts).

Responses

200application/json

OK

• successboolean
• payloadobject
  Show child attributes

  • courseLearningWorkspaceCourseDetail
    Show child attributes

    • idstring<uuid>
    • titlestring
    • statusstring

      Allowed values

      "draft", "published"

    • duration_minutesinteger | null
    • stepsinteger

      Steps that count toward completion (claim and survey steps do not).

    • sourceLearningCourseSource

      Where the course came from.

      Show child attributes

      • kindstring

        Allowed values

        "session", "synced", "written"

      • event_idinteger

        session only.

      • event_namestring | null

        session only.

    • creditLearningCourseCredit | null

      The course's credit by credit type. Types are never added together: amount and type are set only when there is one type; label lists each (e.g. 1.00 AMA PRA Category 1 Credit · 1.00 ANCC Contact Hours).

      Show child attributes

      • amountnumber | null
      • typestring | null
      • by_typeLearningCreditAmount[]
        Show child attributes

        • namestring
        • amountnumber
      • labelstring
    • learnersinteger
    • completedinteger
    • published_atstring<date-time> | null
  • learnersLearningCourseLearner[]
    Show child attributes

    • person_idstring<uuid>
    • namestring
    • emailstring | null
    • doneinteger

      Steps completed.

    • stepsinteger
    • percentinteger | null

      null when the course has no steps that count.

    • completedboolean
    • started_atstring<date-time>
    • completed_atstring<date-time> | null
    • last_activity_atstring<date-time>

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

No such course in your organization (Course 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": {
    "course": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "status": "draft",
      "duration_minutes": 123,
      "steps": 123,
      "source": {
        "kind": "session",
        "event_id": 123,
        "event_name": "<string>"
      },
      "credit": {
        "amount": 123.45,
        "type": "<string>",
        "by_type": [
          {
            "name": "<string>",
            "amount": 123.45
          }
        ],
        "label": "<string>"
      },
      "learners": 123,
      "completed": 123,
      "published_at": "2026-01-15T09:30:00Z"
    },
    "learners": [
      {
        "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "done": 123,
        "steps": 123,
        "percent": 123,
        "completed": true,
        "started_at": "2026-01-15T09:30:00Z",
        "completed_at": "2026-01-15T09:30:00Z",
        "last_activity_at": "2026-01-15T09:30:00Z"
      }
    ]
  }
}

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"
}