Skip to content

List course packages

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

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

The organization's SCORM, xAPI and cmi5 packages, newest first. Requires read:learning. Also at GET /v1/learning/workspace/packages.

Request example

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

Query parameters

  • qstringquery

    Words in the title.

    Max length
    100
  • archivedstringquery
    Allowed values
    "true", "false"

Responses

200application/json

OK

  • successboolean
  • payloadobject
    Show child attributes
    • packagesLearningCoursePackage[]
      Show child attributes
      • idstring<uuid>
      • titlestring
      • standardstring | null
        Allowed values
        "scorm12", "scorm2004", "xapi", "cmi5"
      • standard_labelstring | null
        Example
        "SCORM 2004"
      • statusstring
        Allowed values
        "processing", "ready", "failed"
      • errorstring | null

        Why it couldn't be unpacked.

      • file_countinteger | null
      • size_bytesinteger | null
      • versionstring | null
      • mastery_scorenumber | null

        The pass mark the package sets, 0 to 1.

      • warningsstring[]
      • skippedobject[]

        Files in the zip that aren't served, and why.

        Show child attributes
        • pathstring
        • reasonstring
      • skipped_countinteger
      • preview_urlstring | null

        The launcher, for a preview that saves nothing.

      • archivedboolean
      • created_atstring<date-time>
      • 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": {
"packages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"standard": "scorm12",
"standard_label": "SCORM 2004",
"status": "processing",
"error": "<string>",
"file_count": 123,
"size_bytes": 123,
"version": "<string>",
"mastery_score": 123.45,
"warnings": [
"<string>"
],
"skipped": [
{
"path": "<string>",
"reason": "<string>"
}
],
"skipped_count": 123,
"preview_url": "<string>",
"archived": true,
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z"
}
]
}
}