D2L Brightspace

D2L Brightspace is an enterprise learning management system (LMS) used by higher education, K-12, and corporate organizations. Its public REST API is the Valence Learning Framework API, exposed under https://{host}/d2l/api/ and split into two product components - "lp" (Learning Platform - users, roles, enrollments, org units, data hub) and "le" (Learning Environment - content, grades, assignments/dropbox, quizzes, discussions, calendar, news, learning outcomes). Routes are versioned per component (for example lp 1.x and le 1.x) and authenticated with OAuth 2 bearer tokens issued by the D2L auth service; the older ID-Key (app-id/user-id) scheme is deprecated. D2L is the vendor; Valence is the historical name of the API framework.

12 APIs 0 Features
LMSLearning Management SystemEdTechEducationValenceD2LBrightspace

APIs

Brightspace Users API

Manage user accounts on the Learning Platform - retrieve the current caller (whoami), list and search users, create, update, and delete users, manage legal/preferred names, acti...

Brightspace Enrollments API

Enroll and unenroll users in org units, list the users enrolled in a course or department, list the org units a user belongs to, read the caller's own enrollments, and perform b...

Brightspace Org Units API

Read and manage the organization structure - org units and their parent/child/ancestor/descendant relationships, org unit types, course offerings, departments and semesters, the...

Brightspace Content API

Build and read course content - the root table of contents, modules and their structure, topics and topic files, and per-user access information within a course offering.

Brightspace Grades API

Read and write the course gradebook - grade objects, grade values per user (including my grades), final calculated grades, grade categories, grade schemes, and grade exemptions.

Brightspace Assignments (Dropbox) API

Manage assignment (Dropbox) folders and categories, read and create learner submissions, download submitted files, and post instructor feedback and attachments. Assignments are ...

Brightspace Quizzes API

Create and read quizzes, list quiz attempts and questions, manage quiz categories, and configure special access rules per learner within a course offering.

Brightspace Discussions API

Manage discussion forums, topics, and posts, including replies, ratings, flags, read status, approval, and post attachments within a course offering.

Brightspace Calendar API

Create, read, update, and delete calendar events for a course offering, list a caller's events and event occurrences, and manage event presenters.

Brightspace News (Announcements) API

Create, read, update, publish, dismiss, and delete news (announcement) items in a course offering, manage attachments, and configure cross-org-unit sharing rules.

Brightspace Learning Outcomes API

Manage learning outcome sets and outcomes at the organization and org unit level, bulk import and export outcomes, and read and create outcome alignments against course activities.

Brightspace Data Hub API

Discover and export bulk institutional data through the Data Hub and Data Export Framework - list available data sets, create and monitor export jobs, download the resulting CSV...

Collections

D2L Brightspace Valence API

OPEN

Pricing Plans

Brightspace Plans Pricing

3 plans

PLANS

Rate Limits

Brightspace Rate Limits

4 limits

RATE LIMITS

FinOps

Brightspace Finops

FINOPS

Resources

🔗
DomainSecurity
DomainSecurity
🔑
Authentication
Authentication
🔑
OAuthScopes
OAuthScopes
👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
📰
Blog
Blog

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: D2L Brightspace Valence API
  version: '1.0'
  description: 'The Valence Learning Framework API is the public REST API for the D2L Brightspace LMS, served from an institution''s
    own host under https://{host}/d2l/api/. It splits into two product components: lp (Learning Platform) and le (Learning
    Environment). Each is independently versioned (for example lp/1.53, le/1.92) and varies per instance. Authentication uses
    OAuth 2 bearer tokens issued by the D2L auth service; the legacy ID-Key scheme is deprecated. Replace host, the version
    segments, orgUnitId, and userId with values for your instance.'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Get current user context (whoami).
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/users/whoami
    docs: Retrieves the identity the current access token is acting as.
  - info:
      name: List or search users.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/users/
      params:
      - name: orgDefinedId
        value: ''
        type: query
        description: Filter by org-defined id.
      - name: bookmark
        value: ''
        type: query
        description: Paging bookmark.
    docs: Retrieves a paged list of users, optionally filtered.
  - info:
      name: Create a user.
      type: http
    http:
      method: POST
      url: https://{{host}}/d2l/api/lp/1.53/users/
      body:
        type: json
        data: "{\n  \"OrgDefinedId\": \"stu-001\",\n  \"FirstName\": \"Jane\",\n  \"LastName\": \"Doe\",\n  \"ExternalEmail\"\
          : \"jane.doe@example.edu\",\n  \"UserName\": \"jdoe\",\n  \"RoleId\": 110,\n  \"IsActive\": true,\n  \"SendCreationEmail\"\
          : false\n}"
    docs: Creates a new user account.
  - info:
      name: Get a user.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/users/:userId
      params:
      - name: userId
        value: ''
        type: path
        description: The user identifier.
    docs: Retrieves a single user by identifier.
  - info:
      name: List roles.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/roles/
    docs: Retrieves the roles defined on the organization.
- info:
    name: Enrollments
    type: folder
  items:
  - info:
      name: List users enrolled in an org unit.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/enrollments/orgUnits/:orgUnitId/users/
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The org unit identifier.
    docs: Retrieves the users enrolled in an org unit.
  - info:
      name: List the caller's enrollments.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/enrollments/myenrollments/
    docs: Retrieves the current user's own enrollments.
  - info:
      name: Enroll a user.
      type: http
    http:
      method: POST
      url: https://{{host}}/d2l/api/lp/1.53/enrollments/
      body:
        type: json
        data: "{\n  \"OrgUnitId\": 6606,\n  \"UserId\": 0,\n  \"RoleId\": 110\n}"
    docs: Enrolls a user in an org unit with a role.
- info:
    name: Org Units
    type: folder
  items:
  - info:
      name: List org units.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/orgstructure/
    docs: Retrieves a paged list of org units.
  - info:
      name: Get organization info.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/organization/info
    docs: Retrieves top-level organization information.
- info:
    name: Content
    type: folder
  items:
  - info:
      name: Get root content modules.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/:orgUnitId/content/root/
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The course org unit identifier.
    docs: Retrieves the root modules (table of contents) for a course.
- info:
    name: Grades
    type: folder
  items:
  - info:
      name: List grade objects.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/:orgUnitId/grades/
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The course org unit identifier.
    docs: Retrieves the grade objects in a course gradebook.
  - info:
      name: Get a user's final grade.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/:orgUnitId/grades/final/values/:userId
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The course org unit identifier.
      - name: userId
        value: ''
        type: path
        description: The user identifier.
    docs: Retrieves a user's final calculated/adjusted grade.
- info:
    name: Assignments
    type: folder
  items:
  - info:
      name: List assignment folders.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/:orgUnitId/dropbox/folders/
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The course org unit identifier.
    docs: Retrieves the assignment (dropbox) folders in a course.
- info:
    name: Quizzes
    type: folder
  items:
  - info:
      name: List quizzes.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/:orgUnitId/quizzes/
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The course org unit identifier.
    docs: Retrieves the quizzes in a course.
- info:
    name: Discussions
    type: folder
  items:
  - info:
      name: List discussion forums.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/:orgUnitId/discussions/forums/
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The course org unit identifier.
    docs: Retrieves the discussion forums in a course.
- info:
    name: Calendar
    type: folder
  items:
  - info:
      name: List calendar events.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/:orgUnitId/calendar/events/
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The course org unit identifier.
    docs: Retrieves the calendar events for a course.
- info:
    name: News
    type: folder
  items:
  - info:
      name: List news items.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/:orgUnitId/news/
      params:
      - name: orgUnitId
        value: ''
        type: path
        description: The course org unit identifier.
    docs: Retrieves the news (announcement) items in a course.
- info:
    name: Learning Outcomes
    type: folder
  items:
  - info:
      name: List organization outcome sets.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/le/1.92/lo/outcomeSets/
    docs: Retrieves the organization-level learning outcome sets.
- info:
    name: Data Hub
    type: folder
  items:
  - info:
      name: List available data sets.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/dataExport/list
    docs: Lists the data sets available through the Data Export Framework.
  - info:
      name: Create an export job.
      type: http
    http:
      method: POST
      url: https://{{host}}/d2l/api/lp/1.53/dataExport/create
      body:
        type: json
        data: "{\n  \"DataSetId\": \"\",\n  \"Filters\": []\n}"
    docs: Creates an export job for a requested data set.
  - info:
      name: List Brightspace Data Sets.
      type: http
    http:
      method: GET
      url: https://{{host}}/d2l/api/lp/1.53/datasets/bds
    docs: Retrieves the Brightspace Data Sets schemas and extracts.