Get the Learning workspace home

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

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

The Learning workspace home: who learns here (the setup answers and the door they imply, companies or associations), which sections lead, the counts behind the home tiles, what is ready for a person's review (course drafts, meeting courses still in draft, certifications about to lapse) and whether Learning is on for the organization (module.on). Counts are totals, never learner rows. Any member of the organization can read it, even before Learning is turned on. Reads only. Requires read:learning; refused for a key restricted to particular events. Also at GET /v1/learning/workspace.

Request example

cURL

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

JavaScript

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

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.

Responses

200application/json

OK

• successboolean
• payloadLearningWorkspaceHome
  Show child attributes

  • organizationobject
    Show child attributes

    • idstring<uuid>
    • namestring
  • profileLearningWorkspaceProfile

    The setup answers, with the defaults they imply.

    Show child attributes

    • learnersstring[]

      Allowed values

      "members_public", "customers_partners", "employees"

    • doorstring

      Allowed values

      "associations", "companies"

    • credit_typesstring[]

      Allowed values

      "ama_pra_1", "moc", "ancc", "acpe", "cle", "cpe", "ceu", "other"

    • contentstring[]

      Allowed values

      "recordings", "webinars", "sessionboard_meeting", "documents", "other_lms"

    • other_lmsstring | null

      Allowed values

      "elevate", "path", "oasis", "docebo", "absorb", "cornerstone", "moodle", "other", "none", null

    • signinstring

      Allowed values

      "ams", "sso", "email"

    • amsstring | null

      Allowed values

      "imis", "nimble", "fonteva", "netforum", "personify", "yourmembership", "other", null

    • assistantstring[]

      The assistant jobs switched on. All are on until asked.

      Allowed values

      "captions_chapters", "draft_questions", "reminders", "reports"

    • credits_enabledboolean
    • askedobject

      Which setup questions have been answered.

      Show child attributes

      • learnersboolean
      • credit_typesboolean
      • contentboolean
      • signinboolean
      • assistantboolean
    • finishedboolean
    • finished_atstring<date-time> | null
  • navobject
    Show child attributes

    • creditsstring

      Whether the Credits section shows.

      Allowed values

      "on", "off"

    • leadstring

      The section that leads (associations lead with credits, companies with certifications).

      Allowed values

      "credits", "certifications"

  • countsLearningWorkspaceCounts
    Show child attributes

    • courses_publishedinteger
    • courses_draftinteger
    • certificationsinteger

      Published certifications.

    • learnersinteger

      People with any course progress.

    • active_learners_30dinteger
    • certifiedinteger

      Active

    • certified_30dinteger
    • expiring_30dinteger
    • overdueinteger

      Assignments past due and not completed.

    • assignedinteger
    • assigned_doneinteger
    • drafts_readyinteger

      Course drafts ready for review.

    • drafts_workinginteger

      Course drafts queued or generating.

    • sitesinteger

      Learning Sites.

    • credit_30dnumber

      Credit claimed in the last 30 days

    • claims_30dinteger
    • transcriptsinteger

      People with at least one credit claim.

  • reviewLearningReviewItem[]

    What is waiting on a person, up to 5 drafts, 3 meetings and 3 certifications.

    Show child attributes

    • kindstring

      Allowed values

      "course_draft", "meeting_on_demand", "expiring"

    • idstring

      The draft id, the event id (as text) or the certification id.

    • titlestring
    • detailstring
    • actionstring

      Allowed values

      "review", "remind"

    • hrefstring

      Path inside the Learning workspace.

    • atstring<date-time> | null
  • moduleobject
    Show child attributes

    • onboolean

      Whether Learning is on for the organization.

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

200

{
  "success": true,
  "payload": {
    "organization": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "profile": {
      "learners": [
        "members_public"
      ],
      "door": "associations",
      "credit_types": [
        "ama_pra_1"
      ],
      "content": [
        "recordings"
      ],
      "other_lms": "elevate",
      "signin": "ams",
      "ams": "imis",
      "assistant": [
        "captions_chapters"
      ],
      "credits_enabled": true,
      "asked": {
        "learners": true,
        "credit_types": true,
        "content": true,
        "signin": true,
        "assistant": true
      },
      "finished": true,
      "finished_at": "2026-01-15T09:30:00Z"
    },
    "nav": {
      "credits": "on",
      "lead": "credits"
    },
    "counts": {
      "courses_published": 123,
      "courses_draft": 123,
      "certifications": 123,
      "learners": 123,
      "active_learners_30d": 123,
      "certified": 123,
      "certified_30d": 123,
      "expiring_30d": 123,
      "overdue": 123,
      "assigned": 123,
      "assigned_done": 123,
      "drafts_ready": 123,
      "drafts_working": 123,
      "sites": 123,
      "credit_30d": 123.45,
      "claims_30d": 123,
      "transcripts": 123
    },
    "review": [
      {
        "kind": "course_draft",
        "id": "<string>",
        "title": "<string>",
        "detail": "<string>",
        "action": "review",
        "href": "<string>",
        "at": "2026-01-15T09:30:00Z"
      }
    ],
    "module": {
      "on": true
    }
  }
}

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": "NOT_FOUND",
  "message": "Organization not found"
}

429

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