Blackboard

Retrieves a list of academic terms or information about specific terms in the Blackboard learning management system. This endpoint provides access to term definitions, including start and end dates, term names, and other relevant metadata. It's useful for applications that need to synchronize academic calendars, manag…

Untrusted display-only summary

Retrieves the Table of Contents (TOC) items for a specified course in the Blackboard learning management system. This endpoint provides access to the structured organization of educational materials within a course, including modules, lessons, assignments, and other content types. It should be used when needing to dis…

Untrusted display-only summary

Retrieves detailed information about a specified OAuth2 token used for authentication in the Blackboard Learn API. This endpoint allows developers to verify the validity, scope, and associated details of an access token. It should be used when an application needs to check the current state or permissions of a token,…

Untrusted display-only summary

Retrieves detailed information about a specific tool associated with a particular node in the Blackboard institutional hierarchy. This endpoint is used to fetch configuration, settings, or status details for a given tool type within a specific organizational unit (node) of an educational institution. It allows develop…

Untrusted display-only summary

Retrieves a list of resources associated with a specific course in the Blackboard Learning Management System (LMS). This endpoint allows users to access educational materials, such as assignments, readings, and other study materials, that are linked to a particular course. It should be used when there's a need to fetc…

Untrusted display-only summary

Retrieves a list of available goal set types in the Blackboard Learn system. This endpoint allows users to fetch information about the different categories or classifications of goal sets that can be created or managed within the learning management system. It is useful for understanding the structure and organization…

Untrusted display-only summary

Retrieves detailed information about a specific user in the Blackboard Learn system. This endpoint allows you to fetch user profile data, such as name, email, system role, and other relevant details associated with the user account. It should be used when you need to access or display information about a particular us…

Untrusted display-only summary

Retrieves the avatar (profile picture) for a specified user in the Blackboard Learn platform. This endpoint allows you to fetch the current profile image associated with a user's account based on their unique user ID. It should be used when you need to display or access a user's avatar within your application or integ…

Untrusted display-only summary

Retrieves detailed gradebook information for a specific user within a particular course in the Blackboard learning management system. This endpoint allows educators, administrators, or authorized users to access individual student performance data, including grades, assignments, and other relevant gradebook entries. I…

Untrusted display-only summary

Retrieves a list of courses associated with a specific user in the Blackboard Learn platform. This endpoint is used to fetch all courses that a user is enrolled in or has access to, providing essential information for course management and user-specific content delivery. It's particularly useful for generating user da…

Untrusted display-only summary

Retrieves the pronunciation audio associated with a specific user's profile in Blackboard Learn. This endpoint allows applications to access the audio file that contains the correct pronunciation of the user's name. It should be used when there's a need to play or display the audio pronunciation of a user's name, such…

Untrusted display-only summary

The GetUsersEndpoint retrieves user information from the Blackboard Learn system. This endpoint allows you to fetch a list of users with their associated details, supporting various query parameters for filtering, sorting, and pagination. It's particularly useful for applications that need to synchronize user data, ma…

Untrusted display-only summary

Retrieves the current version information of the Blackboard Learn system. This endpoint should be used when developers or administrators need to check the specific version of the Blackboard instance they are working with. It's particularly useful for ensuring compatibility with other tools or services that integrate w…

Untrusted display-only summary

Retrieves a specific user's grade for a particular gradebook column in a Blackboard Learn course. This endpoint allows instructors or administrators to fetch individual grade entries, providing a targeted way to access student performance data. It's particularly useful for generating individual student reports, verify…

Untrusted display-only summary

Retrieves a list of users belonging to a specific group within a course in the Blackboard learning management system. This endpoint is useful for obtaining detailed information about group members, such as their names, roles, and other relevant data. It should be used when you need to access user information for a par…

Untrusted display-only summary

Creates a new course in the Blackboard Learn system with specified attributes and settings. This endpoint allows for the creation of both academic courses and organizational units, with extensive customization options for course properties, availability, enrollment methods, and localization. It should be used when set…

Untrusted display-only summary

Updates a user's information within a specific group of a course in Blackboard Learn. This endpoint allows for modifying user-related data or settings in the context of a particular course group. It should be used when changes need to be made to a user's status, role, or other attributes specific to their participatio…

Untrusted display-only summary

Retrieves the categories associated with a specific goal set in the Blackboard learning management system. This endpoint is used to fetch the organizational structure of educational objectives within a predefined set of goals. It should be used when needing to understand or display the categorization of learning objec…

Untrusted display-only summary

Retrieves all gradebook columns for a specified course in the Blackboard learning management system. This endpoint allows instructors or authorized users to access the structure and details of the gradebook for a particular course. It returns information about each column, such as column name, points possible, creatio…

Untrusted display-only summary

Retrieves detailed information about a specific group within a Blackboard course. This endpoint is used to fetch comprehensive data about a group, including its name, description, membership details, and other relevant attributes. It's particularly useful for applications that need to display or manage group informati…

Untrusted display-only summary

Retrieves detailed information about a specific user within a group in a Blackboard Learn course. This endpoint allows developers to access user data in the context of both the course and the group, providing insights into the user's role, permissions, and activities within that specific group and course. Use this end…

Untrusted display-only summary

Retrieves a list of courses from the Blackboard Learn environment. This endpoint is essential for applications that need to access and display course information within the Learning Management System (LMS). It allows developers to fetch course data for various purposes such as building course catalogs, managing enroll…

Untrusted display-only summary

Creates a new grade column in a Blackboard course's gradebook. This endpoint allows instructors or administrators to add a new column for recording and managing student grades within a specific course. It provides extensive customization options for grading methods, score calculations, student visibility, and anonymou…

Untrusted display-only summary

This endpoint allows for updating specific properties of an existing grade column within a course's gradebook in the Blackboard Learn platform. It provides granular control over various aspects of the grade column, including its metadata, scoring configuration, visibility to students, and grading settings. The PATCH o…

Untrusted display-only summary

This endpoint allows you to update an existing course announcement in the Blackboard Learn platform. It can modify the announcement's title, body content, draft status, and availability settings. The body content supports rich text formatting using BbML (Blackboard Markup Language), enabling the creation of visually a…

Untrusted display-only summary

This endpoint allows you to update the settings of a specific tool within a node of Blackboard's institutional hierarchy. It provides granular control over tool availability and configuration for different user types (regular, guest, and observer). Use this endpoint when you need to modify existing tool settings, such…

Untrusted display-only summary

Posts a new message to a specific discussion within a Blackboard Learn course. This endpoint allows users to contribute to course discussions by adding new messages, supporting both general course discussions and group-specific discussions. It provides options for setting the message status, enabling features like dra…

Untrusted display-only summary

Deletes a specified child course from a parent course in the Blackboard learning management system. This endpoint is used to remove a sub-course or section from the main course structure, helping to organize and manage course hierarchies. It should be used when restructuring courses, removing outdated sections, or cle…

Untrusted display-only summary

This endpoint removes a specific user from a designated group within a course in Blackboard Learn. It is used when an administrator or instructor needs to adjust group membership, such as when a student changes project teams or is no longer part of a specific study group. The operation is final and will immediately re…

Untrusted display-only summary

This endpoint deletes a specific announcement within a course in the Blackboard Learn platform. It allows administrators or authorized users to remove outdated, incorrect, or unnecessary announcements from a course, helping to maintain clear and relevant communication. The operation is irreversible, so it should be us…

Untrusted display-only summary