Preview a meeting on demand

GET/v1/organization/{orgId}/learning/workspace/on-demand/{eventId}

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

For each session of the event: its recording, faculty and missing faculty disclosures, credit by credit type, attendance count, the registration platform it came from, and whether it is a course yet (and whether that course still waits for a recording); plus totals for the event. Every value is read from the event's own records. Reads only. Requires read:learning; refused for a key restricted to particular events. Also at GET /v1/learning/workspace/on-demand/{eventId}.

Request example

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

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

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

import requests

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

print(response.json())

<?php

$curl = curl_init();

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

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

echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/on-demand/{eventId}", 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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/on-demand/{eventId}"))
    .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

Response headers

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.
eventIdintegerpathrequired
The Sessionboard event. Another organization's event answers 401.
Minimum
1

Responses

200`application/json`

successboolean
payloadLearningOnDemandPreview
Show child attributes
- eventobject
  Show child attributes
  - idinteger
  - namestring
  - date_fromstring<date-time> | null
  - date_tostring<date-time> | null
  - event_formatstring | null
    Allowed values
    "standard", "lite", "gathering", "webinar", null
- sessionsLearningOnDemandSession[]
  Show child attributes
  - idstring<uuid>
  - titlestring
  - recordingobject | null
    Show child attributes
    minutesinteger | null
    countinteger
  - facultyinteger
  - disclosures_missinginteger
    Faculty with no disclosure on file.
  - creditobject | null
    The session's credit, or the credit set on the course made from it (the course's wins per type). Types are never added together.
    Show child attributes
    amountnumber | null
    Only with one type.
    type_namestring | null
    Only with one type.
    typesinteger
    by_typeLearningCreditAmount[]
    Show child attributes
    namestring
    amountnumber
    labelstring
  - attendanceinteger
  - sourceobject | null
    The registration platform it came from.
    Show child attributes
    appstring
    external_idstring
  - courseobject | null
    Show child attributes
    idstring<uuid>
    statusstring
    Allowed values
    "draft", "published", "archived"
    waiting_for_recordingboolean
    recording_readyboolean
    Waiting, and the session now has a recording; make courses again to add it.
- totalsLearningOnDemandTotals
  Show child attributes
  - sessionsinteger
  - with_recordingsinteger
  - facultyinteger
  - disclosures_missinginteger
    Sessions with a faculty disclosure missing.
  - credit_sessionsinteger
  - attendanceinteger
  - courses_publishedinteger
  - courses_draftinteger
  - waiting_for_recordinginteger
  - importedinteger
    Sessions brought in from a registration platform.

400`application/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, or the event does not belong to your organization (Event does not belong to your organization).

403`application/json`

As for every Learning workspace operation:

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."
EVENT_ARCHIVED — the event is archived.
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>

404`application/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>

429`application/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": {
    "event": {
      "id": 123,
      "name": "<string>",
      "date_from": "2026-01-15T09:30:00Z",
      "date_to": "2026-01-15T09:30:00Z",
      "event_format": "standard"
    },
    "sessions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "recording": {
          "minutes": 123,
          "count": 123
        },
        "faculty": 123,
        "disclosures_missing": 123,
        "credit": {
          "amount": 123.45,
          "type_name": "<string>",
          "types": 123,
          "by_type": [
            {
              "name": "<string>",
              "amount": 123.45
            }
          ],
          "label": "<string>"
        },
        "attendance": 123,
        "source": {
          "app": "<string>",
          "external_id": "<string>"
        },
        "course": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "draft",
          "waiting_for_recording": true,
          "recording_ready": true
        }
      }
    ],
    "totals": {
      "sessions": 123,
      "with_recordings": 123,
      "faculty": 123,
      "disclosures_missing": 123,
      "credit_sessions": 123,
      "attendance": 123,
      "courses_published": 123,
      "courses_draft": 123,
      "waiting_for_recording": 123,
      "imported": 123
    }
  }
}

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

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

{
  "error": "NOT_FOUND",
  "message": "Organization not found"
}

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

Preview a meeting on demand

Request example

Try it

Authorizations

Path parameters

Responses

200application/json

400application/json

401

403application/json

404application/json

429application/json

Response examples

200`application/json`

400`application/json`

403`application/json`

404`application/json`

429`application/json`