Skip to content

Read a course's public page

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

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

What visitors see before they enrol. summary is the saved description; when there is none, summary_draft offers one written from the course's first page, and nothing is shown publicly until someone saves it. learn lists what you'll learn (the page titles, quizzes left out). cover is the first video's frame (source: video), else the Learning Site's Brand Kit image (source: brand), else null. Requires read:learning. Also at GET /v1/learning/workspace/courses/{lessonId}/page.

Request example

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

Try it

Authorization

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
GET

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

The course's page.

  • payloadobject
    Show child attributes
    • pageobject
      Show child attributes
      • idstring<uuid>
      • titlestring
      • summarystring | null

        The saved description; null when none.

      • summary_draftstring | null

        A suggested description when none is saved. Never public on its own.

      • learnstring[]
      • duration_minutesinteger | null
      • coverobject | null
        Show child attributes
        • urlstring<uri>
        • sourcestring
          Allowed values
          "video", "brand"

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

orgId is not your organization (error: NOT_FOUND, message: Organization not found).

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

{
"payload": {
"page": {
"id": "3f1c2a9e-0000-4000-8000-000000000001",
"title": "Sepsis recognition for nurses",
"summary": null,
"summary_draft": "Spot sepsis early at the bedside and know who to call.",
"learn": [
"Spot it early",
"Escalate fast"
],
"duration_minutes": 25,
"cover": {
"url": "https://content.sessionboard.com/frames/example.jpg",
"source": "video"
}
}
}
}