Skip to content

List courses and course drafts

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

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

Every course that is not archived (up to 200, most recently changed first) with where it came from (a meeting session, a synced catalog or written here), its credit by credit type, how many learners started it and how many completed it; plus up to 50 course drafts made from recordings (queued, generating, ready or failed) and the credit set on each. Reads only. Requires read:learning; refused for a key restricted to particular events. Also at GET /v1/learning/workspace/courses.

Request example

Terminal window
curl --request GET \
--url 'https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/courses' \
--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.

Responses

200application/json

OK

  • successboolean
  • payloadobject
    Show child attributes
    • coursesLearningWorkspaceCourse[]
      Show child attributes
      • idstring<uuid>
      • titlestring
      • statusstring
        Allowed values
        "draft", "published"
      • duration_minutesinteger | null
      • 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

        People who started it.

      • completedinteger

        People who finished every step that counts.

      • updated_atstring<date-time>
      • published_atstring<date-time> | null
    • draftsLearningWorkspaceCourseDraft[]
      Show child attributes
      • idstring<uuid>
      • statusstring
        Allowed values
        "queued", "generating", "ready", "failed"
      • titlestring | null
      • progressobject | null
        Show child attributes
        • stepstring
        • doneinteger
        • totalinteger
      • errorstring | null
      • creditobject | null

        The credit a person set on the draft, applied on publish.

        Show child attributes
        • credit_type_idstring<uuid>
        • amountnumber
      • updated_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

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

{
"success": true,
"payload": {
"courses": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"status": "draft",
"duration_minutes": 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,
"updated_at": "2026-01-15T09:30:00Z",
"published_at": "2026-01-15T09:30:00Z"
}
],
"drafts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"title": "<string>",
"progress": {
"step": "<string>",
"done": 123,
"total": 123
},
"error": "<string>",
"credit": {
"credit_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": 123.45
},
"updated_at": "2026-01-15T09:30:00Z"
}
]
}
}