Team
Shared credential for production and unattended runs.
Anthology Adopt powered by Pendo allows institutions to gain insights on Blackboard Learn usage and take action through in-app messages, digital walkthrough guides, and tooltips.
Tools and triggers
Available tools and events after Blackboard is connected.
Creates a new adaptive release rule for a specific content item within a Blackboard course. This endpoint allows instructors or course administrators to set up conditions for releasing course content to students based…
Creates a new category in the Blackboard catalog system. This endpoint allows administrators to define and organize content categories within the learning management system. Use this tool to add a new category with…
Creates a new child node within the institutional hierarchy of Blackboard Learn. This endpoint allows administrators to expand and organize the structure of their educational institution by adding new nodes as children…
Adds an attachment to a specific content item within a Blackboard Learn course. This endpoint allows developers to programmatically upload and associate files with course materials, enhancing the content available to…
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…
Creates a new grade column in a course's gradebook within the Blackboard Learn platform. This endpoint allows instructors or administrators to set up various types of grade columns, including manual entry, calculated…
This endpoint creates a copy of an existing course in the Blackboard learning management system. It allows instructors or administrators to duplicate course content, settings, and structure into a new or existing…
The CourseCopyTool allows you to create a copy of a Blackboard course with fine-grained control over which elements are included in the copy. This endpoint is used when you need to duplicate a course, either creating a…
Retrieves a list of announcements for a specific course in the Blackboard learning management system. This endpoint allows users to access important messages, updates, or notifications related to a particular course…
Retrieves detailed information about a specific course in the Blackboard Learn platform using its unique identifier. This endpoint allows users to fetch comprehensive course data, which may include the course name…
Creates a new course in the Blackboard Learn system with specified settings and configurations. This endpoint allows administrators or instructors to set up a course with various parameters including its basic…
Creates a new course in the Blackboard Learn system with specified attributes and settings. This endpoint allows for the detailed configuration of a course, including its basic information, availability, enrollment…
This endpoint allows for the creation of new adaptive release criteria for a specific rule within a course's content in Blackboard. It is used to define conditions under which course content will be made available to…
Creates a new assignment within a specified Blackboard course. This endpoint allows instructors to set up detailed assignments with customizable settings for availability, grading, and plagiarism detection. It supports…
This endpoint creates a new calendar item in the Blackboard platform. It allows users to add various types of events, such as course-related activities, personal appointments, or institution-wide events, to specific…
Creates a new content item within a specified course and parent content in the Blackboard Learn platform. This endpoint allows for the creation of various types of content, such as documents, external links, folders…
Creates a new announcement within a specified course in the Blackboard learning management system. This endpoint allows instructors or course administrators to post important messages, updates, or notifications to all…
Creates new content within a specified Blackboard course. This endpoint allows for the addition of various types of content, including documents, external links, folders, and more, with detailed configuration options…
Creates a new gradebook schema for a specific course in Blackboard Learn. This endpoint allows instructors or administrators to define custom grading structures tailored to their course needs. It supports various…
Creates a new group within a specified course in the Blackboard Learn system. This endpoint allows for detailed customization of group properties, including its name, description, availability, and enrollment settings…
Creates a new group within a specified course in the Blackboard learning management system. This endpoint allows instructors or administrators to set up and configure groups for collaborative work, discussions, or…
Creates a new meeting for a specific course within the Blackboard learning management system. This endpoint allows you to schedule and define the details of a course meeting, including its title, description, start and…
Creates a new rubric for a specific course in Blackboard Learn. This endpoint allows instructors or course designers to define a structured evaluation tool with customizable criteria, performance levels, and scoring…
Creates a new data source in the Blackboard Learn system. This endpoint is used to establish a unique identifier for an external data source, which can then be referenced in other API calls or integrations. It's…
Creates a new discussion forum within a specified course in the Blackboard Learning Management System. This endpoint allows instructors or course administrators to set up a discussion topic, define its availability…
Creates a new grading period within a specific course's gradebook in the Blackboard Learn system. This endpoint allows instructors or administrators to define and organize temporal segments for grade collection and…
Creates a new group within a specified course group set in the Blackboard Learn platform. This endpoint allows instructors or administrators to set up groups with customizable settings for student collaboration and…
Creates a new group set within a specified course in the Blackboard Learn platform. This endpoint allows instructors or administrators to set up a structured group of students for collaborative work, discussions, or…
Creates a new node in the institutional hierarchy of Blackboard. This endpoint allows for the addition of organizational elements such as departments, courses, or other structural units within an educational…
Creates or updates an LTI (Learning Tools Interoperability) domain configuration in Blackboard Learn. This endpoint allows administrators to set up and manage integrations with external learning tools, configuring…
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…
Creates a new LTI (Learning Tools Interoperability) placement in the Blackboard Learn system. This endpoint allows integration of external tools and services into the learning management system, enhancing the…
Uploads a file to the Blackboard Learn platform. This endpoint allows users to add various types of educational content, such as documents, images, or multimedia files, to courses or other areas within Blackboard. It…
Creates a new user account in the Blackboard Learn system with detailed profile information. This endpoint allows for the creation of user profiles with comprehensive data, including personal details, educational…
Creates a new association between a rubric and a specific course content item in the Blackboard learning management system. This endpoint allows instructors or course designers to link a rubric to elements such as…
Creates or updates a rubric evaluation for a specific course, rubric, and rubric association in the Blackboard Learn platform. This endpoint allows instructors or authorized users to submit detailed evaluations of…
Creates a new system-wide announcement in the Blackboard Learn environment. This endpoint allows administrators to compose and configure announcements that can be displayed to users across the platform. The…
Creates a new term in the Blackboard Learn system with the specified attributes. This endpoint allows administrators to define academic periods or sessions, setting up the structure for courses and student enrollments…
Deletes a specific criterion from an adaptive release rule for a content item within a Blackboard course. This endpoint allows instructors or course administrators to remove individual conditions that control when…
Deletes all attendance records in the course meeting for a given meeting Id. The 'course.attendance.DELETE' entitlement is required to delete attendance records. **Since**: 3500.7.0
Deletes a specific announcement from the Blackboard Learning Management System (LMS) using its unique identifier. This endpoint should be used when an instructor, administrator, or authorized user needs to permanently…
Delete attendance record for meeting.It will delete meeting attendance within a course meeting. The 'course.attendance.DELETE' entitlement is required to delete Attendance Record. **Since**: 3500.7.0
This endpoint deletes a specific calendar item from the Blackboard Learn system. It allows users to remove events from personal, course, organization, or institution calendars. The endpoint should be used when a…
This endpoint deletes a specific category from the Blackboard catalog based on the provided category type and ID. It should be used when an administrator or authorized user needs to remove a category that is no longer…
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…
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…
Deletes a specific question from an assessment within a Blackboard course. This endpoint allows instructors or course administrators to remove individual questions from existing assessments, which can be useful for…
Deletes a specific course from the Blackboard Learn platform. This endpoint should be used when an administrator or authorized user needs to permanently remove a course from the system, including all associated…
The DeleteCourse endpoint permanently removes a specific course from the Blackboard Learn platform. This operation deletes all associated course content, assignments, and student data for the specified course. It…
Deletes a specific course from the Blackboard learning management system. This endpoint permanently removes all course data, including content, assignments, and student records associated with the specified course. It…
Removes a specific group from a criterion within an adaptive release rule for a particular content item in a Blackboard course. This endpoint is used to modify the access conditions for course content by eliminating a…
Deletes a specific attachment from a content item within a course in Blackboard Learn. This endpoint should be used when an instructor or authorized user needs to remove an attachment from course materials. It…
Deletes a specific content item from a course in the Blackboard learning management system. This endpoint should be used when an administrator or authorized user needs to remove outdated, incorrect, or unnecessary…
This endpoint deletes a specific group associated with a content item within a Blackboard course. It is used to remove group assignments or collaborations tied to particular course content. The operation is…
Removes a specific course from a designated category within the Blackboard Learning Management System (LMS) catalog. This endpoint is used when you need to disassociate a course from a particular category, which can be…
Deletes a specific grade notation from a course's gradebook in Blackboard Learn. This endpoint should be used when an instructor or administrator needs to remove an existing grade notation that is no longer relevant or…
This endpoint deletes a specific group from a course in the Blackboard learning management system. It is used to remove a group that is no longer needed or has been created in error. The operation is permanent and…
Deletes all meetings associated with a specific course in the Blackboard Learn platform. This endpoint should be used when an instructor or administrator needs to remove virtual sessions or scheduled meetings from a…
This endpoint deletes a specific meeting within a course in the Blackboard learning management system. It should be used when an administrator or instructor needs to remove a scheduled meeting from a course, such as…
This endpoint deletes a specific message within a course in the Blackboard learning management system. It should be used when an instructor or authorized user needs to remove a particular message from a course's…
Deletes a specific rubric associated with a given course in the Blackboard Learn system. This endpoint should be used when an instructor or administrator needs to permanently remove a rubric from a course, such as when…
Deletes a specific data source from the Blackboard Learn platform. This endpoint should be used when an administrator needs to permanently remove a data source, such as those related to users, courses, or enrollments…
This endpoint allows for the deletion of a specific message within a discussion thread in a Blackboard course. It should be used when an instructor or authorized user needs to remove inappropriate, outdated, or…
Deletes a specific file associated with an attempt in a course's gradebook within the Blackboard Learn environment. This endpoint should be used when an instructor or administrator needs to remove a file that was…
Deletes a specific gradebook column from a course in the Blackboard Learn system. This endpoint should be used when an instructor or administrator needs to permanently remove a column from the gradebook, such as when a…
Deletes a specific gradebook column from a course in Blackboard Learn. This endpoint allows instructors or administrators to remove a column from the gradebook, which may be necessary for course restructuring or…
Deletes a specific gradebook period from a course in the Blackboard Learning Management System. This endpoint allows administrators or instructors to remove a grading period that is no longer needed or was created in…
This endpoint deletes a specific group within a course in the Blackboard Learning Management System. It is used to remove a group that is no longer needed or to clean up the course structure. The operation is permanent…
This endpoint deletes a specific group set within a course in the Blackboard learning management system. It permanently removes the entire group set, including all associated groups and their memberships, from the…
Removes an administrator's access from a specific node in the institutional hierarchy of Blackboard Learn. This endpoint should be used when you need to revoke administrative privileges for a user at a particular level…
Deletes a specific node from the institutional hierarchy in Blackboard Learn. This endpoint should be used when an administrator needs to remove a node, such as a department, school, or program, from the institution's…
This endpoint deletes a specific Learning Tools Interoperability (LTI) placement from the Blackboard Learn platform. LTI placements define where and how external learning tools are integrated within the Blackboard user…
Deletes a specific LTI (Learning Tools Interoperability) domain from the Blackboard learning management system. This endpoint is used to remove an existing domain configuration, which may include associated LTI tool…
Deletes a specific pronoun setting from the Blackboard learning management system. This endpoint is used to remove a user's pronoun preference from the system, identified by a unique pronounId. It should be used when a…
Deletes a specific rubric association within a course in the Blackboard Learn platform. This endpoint removes the link between a rubric and its associated item (such as an assignment or assessment) in a given course…
Removes a specific course from a designated node in the institutional hierarchy of Blackboard Learn. This endpoint is used for managing the organizational structure of courses within an institution's Blackboard…
The DeleteTerm endpoint removes a specific academic term from the Blackboard learning management system. It should be used when an administrator needs to permanently remove a term that is no longer needed, such as an…
This endpoint permanently deletes a user account from the Blackboard Learn platform. It should be used when an administrator needs to remove a user's access and information from the system, such as when a student…
Deletes all meeting attendance records for a specific user within a particular course in the Blackboard system. This endpoint is used when an administrator or instructor needs to remove all attendance data for a…
Removes a specific user from an adaptive release rule criterion for a particular content item within a course. This endpoint is used to modify the conditions under which course content is made available to individual…
Removes a specific user from a particular course in the Blackboard learning management system. This endpoint should be used when an administrator or instructor needs to unenroll a student, remove a teaching assistant…
Removes a specific user from a particular group within a course in the Blackboard learning management system. This endpoint is used when an instructor or administrator needs to remove a student or participant from a…
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…
This endpoint removes a user from a meeting within a specific course in the Blackboard learning management system. It should be used when an administrator or instructor needs to revoke a user's access to a particular…
This endpoint removes a specified user from a particular node within the Institutional Hierarchy of Blackboard Learn. It is used to disassociate a user (such as a student, faculty member, or staff) from a specific…
This endpoint removes a specific observer from a user's list of observers in the Blackboard learning management system. It is used to terminate the observer-user relationship, revoking the observer's ability to monitor…
Downloads a specific attachment from a course's content in the Blackboard learning management system. This endpoint retrieves the file associated with the given attachmentId, which is linked to a particular content…
This endpoint allows for downloading a specific file associated with a student's attempt on an assignment within a Blackboard course. It retrieves the file content based on the provided course, attempt, and file…
Updates a user's enrollment details in a specific Blackboard Learn course. This endpoint allows for modifying various aspects of a user's course membership, including their role, availability status, and association…
Retrieves detailed information about a specific calendar item from the Blackboard learning management system. This endpoint allows you to fetch data for a single calendar entry, such as an event, appointment, or…
Retrieves detailed information about a specific category in the Blackboard catalog system. This endpoint allows users to access category data based on the category type and its unique identifier. It is useful for…
Retrieves a list of resources from a specified content collection within a Blackboard Learn course. This endpoint enables access to various educational materials in a course's content collection. It supports pagination…
Retrieves a list of categories for a specific course within the Blackboard learning management system. This endpoint allows developers to access the organizational structure of a course, providing information about how…
Retrieves a list of all groups associated with a specific course in the Blackboard learning management system. This endpoint is useful for obtaining information about the various student groups, project teams, or study…
Retrieves a list of available course roles in the Blackboard Learn system. This endpoint allows users to fetch all predefined roles that can be assigned to users within courses. It is useful for administrators and…
Retrieves detailed information about a specific task within a course in the Blackboard Learn platform. This endpoint allows users to fetch comprehensive data about an individual assignment, activity, or any other task…
Retrieves a list of data sources available in the Blackboard learning management system. This endpoint provides information about various data sources that can be used for integrating external systems, reporting, or…
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…
This endpoint retrieves a list of goals associated with a specific category within a goal set in the Blackboard learning management system. It allows administrators and educators to access and review the goals that…
Retrieves the files associated with a specific gradebook attempt for a given course in the Blackboard learning management system. This endpoint allows access to student-submitted files for a particular assignment or…
Retrieves information about the nodes within the institutional hierarchy of a Blackboard learning environment. This endpoint allows users to fetch data representing the organizational structure of an educational…
Retrieves a list of active sessions from the Blackboard Learn platform. This endpoint provides information about ongoing learning activities, such as class meetings, online discussions, or interactive modules. It can…
Retrieves a list of all available LTI (Learning Tools Interoperability) placements within the Blackboard Learn environment. This endpoint allows developers and administrators to obtain information about where external…
Retrieves all messages associated with a specific course in the Blackboard learning management system. This endpoint is used to access course-related communication, announcements, and notifications. It provides a…
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…
Retrieves the current privacy policy for the Blackboard system. This endpoint provides access to the most up-to-date privacy policy information, which is crucial for understanding how user data is handled and protected…
Retrieves the rubric evaluations for a specific group attempt within a gradebook column of a Blackboard course. This endpoint is designed to fetch detailed assessment data based on predefined rubric criteria for group…
Retrieves all rubrics associated with a specific course in the Blackboard Learn platform. This endpoint allows users to access the grading criteria and assessment tools set up for a particular course. It's useful for…
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…
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…
Retrieves a list of users who meet a specific criterion within an adaptive release rule for a particular content item in a Blackboard Learn course. This endpoint is used to identify which users have satisfied the…
Retrieves a specific announcement from the Blackboard Learn platform using its unique identifier. This endpoint allows users to fetch detailed information about a single announcement, such as its title, content…
Retrieves a list of questions for a specific assessment within a Blackboard course. This endpoint allows users to access the questions associated with a particular assessment, such as a quiz, test, or assignment, in a…
Returns a Course Meeting Attendance information for the given meeting and user Id. The "course.attendance.VIEW" entitlement is required to view a Course Meeting Attendance. **Since**: 3500.7.0
Returns a list of Course Meeting Attendance for a given meeting id. The "course.attendance.VIEW" entitlement is required to view a Course Meeting attendance. **Since**: 3500.7.0
Retrieves calendar items from the Blackboard Learn platform. This endpoint allows users to fetch a list of calendar events, which may include course schedules, assignment deadlines, and institution-wide events. It…
Get the list of calendars. This endpoint will return all calendars viewable by the user. All users can request a list of calendars viewable to them. **Since**: 3400.9.0
Retrieves a list of child resources for a specified parent resource within the Blackboard content collection. This endpoint is used to navigate through the hierarchical structure of educational content, allowing users…
Retrieves a specific announcement from a particular course in the Blackboard Learn system. This endpoint allows users to fetch detailed information about a single announcement, including its content, creation date, and…
Retrieves the log entries for a specific gradebook column within a Blackboard course. This endpoint provides a detailed history of all actions and changes made to the specified gradebook column, including grade…
Retrieves the groups associated with a specific criterion of an adaptive release rule for a particular content item within a Blackboard course. This endpoint is used to get information about which groups are part of…
Retrieves detailed information about a specific attachment associated with a particular content item within a Blackboard course. This endpoint allows users to access metadata and potentially the content of an…
Retrieves the attachments associated with a specific content item within a Blackboard course. This endpoint allows users to access files, documents, or other resources that have been attached to a particular piece of…
Retrieves detailed information about a specific group within a content item of a course in the Blackboard Learn platform. This endpoint is used to access group-related data, such as group name, description, membership…
Retrieves all discussions associated with a specific course in the Blackboard Learning Management System. This endpoint allows developers to access the discussion forums and threads for a particular course, enabling…
Retrieves detailed information about a specific attempt for a gradebook column in a Blackboard course. This endpoint allows instructors or authorized users to access individual student attempt data, including scores…
Retrieves group attempts data for a specific gradebook column within a course in Blackboard Learn. This endpoint allows users to access detailed information about group submissions, including submission dates, grades…
Retrieves the gradebook logs for a specific course in the Blackboard learning management system. This endpoint provides a historical record of all gradebook-related activities and changes within the specified course…
Retrieves a list of all groups associated with a specific course in the Blackboard learning management system. This endpoint allows educators and administrators to access information about the various student groups…
Retrieves detailed information about a specific meeting within a course in the Blackboard learning management system. This endpoint is used to fetch comprehensive data about a scheduled meeting, including its date…
Retrieves a download URL for meeting-related resources within a specific Blackboard course. This endpoint should be used when access to downloadable content associated with course meetings is required, such as meeting…
Retrieves a list of meetings associated with a specific course in the Blackboard learning management system. This endpoint is used to fetch details about scheduled meetings, such as virtual classroom sessions, office…
Retrieves the content review status for a specific course in the Blackboard learning management system. This endpoint provides information about the current state of content reviews within the course, which may include…
Retrieves a specific resource from a particular course within the Blackboard learning management system. This endpoint is used to access detailed information about a single course resource, such as a document…
Retrieves a list of child resources associated with a specific resource within a Blackboard course. This endpoint is useful for exploring the hierarchical structure of course materials, such as folders, documents, or…
Retrieves a specific rubric for a given course in the Blackboard learning management system. This endpoint allows users to access detailed information about a rubric, including its criteria, scoring methods, and any…
Retrieves a list of courses associated with a specific category in the Blackboard catalog. This endpoint allows users to fetch course information based on the category type and category ID, providing a way to browse or…
Retrieves the cross-listed course set for a specified course in Blackboard Learn. This endpoint is used to obtain information about courses that are linked together, typically representing different sections of the…
Retrieves detailed information about a specific data source within the Blackboard Learn platform. This endpoint allows you to access metadata and configuration details for a particular data source, which can be crucial…
Retrieves all messages within a specific discussion for a given course in the Blackboard learning management system. This endpoint allows users to fetch the entire conversation thread, including all posts and replies…
Retrieves the alignments associated with a specific educational goal in the Blackboard learning management system. This endpoint allows users to fetch the learning activities or assessments that are linked to a…
Retrieves detailed information about a specific goal category within a designated goal set in the Blackboard Learn platform. This endpoint allows users to access the properties and metadata of a particular goal…
Retrieves detailed information about a specific gradebook column for a particular course in the Blackboard learning management system. This endpoint allows educators and administrators to access the configuration and…
Retrieves detailed information about a specific gradebook period within a course in the Blackboard learning management system. This endpoint allows users to access important data related to a particular grading period…
Retrieves the gradebook schemas for a specific course in the Blackboard learning management system. This endpoint allows developers to access the structure and format of the gradebook data for a given course, which is…
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…
Retrieves detailed information about a specific node within the institutional hierarchy of Blackboard. This endpoint allows users to fetch data about a particular component or entity in the educational institution's…
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…
Retrieves information about the last changes made to a specific gradebook column for a particular course in Blackboard. This endpoint is useful for tracking recent modifications to grades, comments, or other gradebook…
The GetGoals endpoint retrieves a list of educational goals within the Blackboard learning management system. It provides access to goal information that can be used to track student progress, align curriculum with…
Initiates the OAuth 2.0 authorization code flow for the Blackboard API. This endpoint is used to obtain an authorization code, which is a crucial step in the OAuth 2.0 authentication process. The authorization code can…
Retrieves the review status of a specific content item for a particular user within a Blackboard Learn course. This endpoint is useful for instructors or administrators to track whether a student has reviewed or…
Retrieves the rubric associations for a specific gradebook column within a Blackboard course. This endpoint allows users to access detailed information about how rubrics are connected to a particular grading column…
Retrieves system information about the Blackboard Learn platform. This endpoint provides essential metadata about the current state of the Blackboard system, which can include details such as the platform version…
Retrieves the current upload settings for the Blackboard Learn platform. This endpoint allows administrators and authorized users to fetch the configuration parameters related to file uploads within the Blackboard…
Retrieves detailed information about a specific user within a particular course in the Blackboard learning management system. This endpoint is used to fetch user-specific data in the context of a given course, which…
Retrieves the gradebook information for a specific user within a particular course in Blackboard. This endpoint allows instructors or authorized personnel to access individual student grade data, including assignment…
Retrieves a list of nodes associated with a specific user in the Blackboard Learn platform. Nodes typically represent courses, organizations, or content areas that the user has access to. This endpoint is useful for…
Retrieves the list of observers associated with a specific user in the Blackboard learning management system. This endpoint is used to fetch information about individuals or entities that have been granted observer…
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…
Retrieves a list of announcements from the Blackboard Learn platform. This endpoint allows users to fetch announcements, which are important messages or updates shared within courses or across the institution. It can…
Retrieves a list of child courses or sub-courses associated with a specified parent course in the Blackboard Learn platform. This endpoint is useful for exploring the hierarchical structure of courses, such as main…
Retrieves the immediate child nodes of a specified parent node in the Blackboard Learn Institutional Hierarchy. This endpoint is used to navigate and explore the hierarchical structure of an educational institution…
Retrieves a list of gradebook columns for a specified course in the Blackboard Learn environment. This endpoint allows users to access detailed information about the structure and components of a course's gradebook. It…
Retrieves a list of groups within a specific group set for a given course in the Blackboard learning management system. This endpoint allows educators and administrators to access detailed information about the groups…
Retrieves a list of users belonging to a specific group within a Blackboard Learn course. This endpoint is used to access user information for group-based activities, collaborative assignments, or administrative…
Retrieves a list of courses from the Blackboard learning management system. This endpoint allows users to fetch information about multiple courses at once, providing an overview of the available courses within the…
Retrieves the grade notations for a specific course's gradebook in the Blackboard learning management system. Grade notations are symbols or short texts used to represent specific grading statuses or conditions (e.g…
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…
Retrieves user data associated with a specific gradebook column for a given course in Blackboard. This endpoint allows educators and administrators to access detailed information about students' performance or…
Retrieves a list of all institution roles defined within the Blackboard Learn environment. This endpoint is crucial for administrators and developers who need to understand and manage the various roles available in…
Retrieves a list of all system roles defined in the Blackboard Learn platform. This endpoint provides comprehensive information about the various roles that can be assigned to users within the system, including their…
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…
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…
This endpoint allows you to update an existing question within a specific assessment in a Blackboard course. It provides the ability to modify various aspects of the question, including its title, content, scoring…
This endpoint updates the criteria for a specific group within an adaptive release rule for a particular content item in a Blackboard course. It allows instructors or course administrators to modify how and when course…
This endpoint allows you to update an existing System Announcement in Blackboard. It provides the ability to modify the announcement's title, content (using BbML formatting), availability settings, and display options…
Updates a user's membership details within a specific Blackboard course. This endpoint allows for modifying various aspects of a user's enrollment, including their role, availability, and position within the course…
Obtains an OAuth2 token for authenticating and authorizing requests to the Blackboard API. This endpoint is essential for securing access to Blackboard's resources and should be used before making any API calls that…
Updates a specific criterion within an adaptive release rule for a course content item in Blackboard Learn. This endpoint allows instructors or administrators to modify the conditions under which course materials…
This endpoint allows you to update an existing calendar item in the Blackboard system. It can be used to modify various aspects of an event, assignment, or other calendar entries, including basic details, recurrence…
This endpoint allows you to update existing content within a specific Blackboard Learn course. It provides extensive control over content properties, including title, body, description, position, availability, and…
Updates the review status of a specific content item for a particular user within a Blackboard Learn course. This endpoint allows for marking course materials as reviewed or not reviewed, which can be useful for…
Updates an existing course in Blackboard Learn with the provided information. This endpoint allows modification of various course attributes including basic details, availability settings, enrollment options, and…
This endpoint allows you to update the details of a specific meeting within a course in the Blackboard learning management system. It uses a PATCH request to modify one or more attributes of an existing meeting, such…
Updates a specific rubric within a Blackboard Learn course. This endpoint allows for modification of various aspects of an existing rubric, including its title, description, type, and detailed grading criteria. It's…
This endpoint allows for updating specific attributes of an existing data source in the Blackboard system. It uses the PATCH method to apply partial modifications to a data source identified by its unique dataSourceId…
The UpdateGrade endpoint allows instructors to modify various aspects of a student's grade for a specific course and gradebook column in the Blackboard Learning Management System. This PATCH operation enables…
This endpoint allows you to update an existing grade notation for a specific course in the Blackboard learning management system. It's used to modify the performance code and/or description associated with a grade…
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…
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…
Updates an existing term in the Blackboard Learn platform. This endpoint allows modification of various term properties, including its external ID, name, description, availability settings, and duration. It's…
This endpoint creates a new question within an existing Blackboard assessment. It supports various question types and allows for customization of content, feedback, and scoring. Use it to build or modify assessments by…
Creates a new message within a specific Blackboard course. This endpoint allows users to compose and send messages to course participants, supporting rich text formatting through BbML, file attachments, and flexible…
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…
Creates a reply to a specific message within a Blackboard course discussion. This endpoint allows users to contribute to ongoing discussions by posting responses to existing messages. It supports both course-wide and…
Creates a new grade notation in the gradebook for a specific course in Blackboard. This endpoint allows instructors or administrators to add custom performance codes and their corresponding descriptions to the grading…
The CreateGroupAttempt endpoint allows for the creation or update of a group attempt for a specific gradebook column in a Blackboard Learn course. This tool is essential for managing group submissions, tracking their…
Creates a new pronoun entry in the Blackboard Learning Management System. This endpoint is used to add new pronouns to the system's user identity management, supporting inclusive and diverse user representation. It…
Retrieves the administrative status of a specific user for a particular node within the Blackboard institutional hierarchy. This endpoint allows you to check whether a user has administrative privileges for a given…
Retrieves detailed information about a specific question within an assessment for a particular course in the Blackboard learning management system. This endpoint allows users to access question content, type, scoring…
Retrieves detailed information about a specific attempt receipt in the Blackboard learning management system. This endpoint allows users to access data related to a student's attempt on an assessment, test, or other…
Retrieves the child categories of a specified parent category within the Blackboard catalog system. This endpoint allows users to navigate through the hierarchical structure of categories, which is crucial for…
Retrieves a list of categories from the Blackboard catalog based on the specified category type. This endpoint is used to fetch organized groups of resources or content within the Blackboard Learn platform, such as…
Retrieves the child elements (sub-goals, tasks, or related items) of a specified goal in the Blackboard learning management system. This endpoint is used to fetch the hierarchical structure of educational objectives…
Retrieves a specific resource from a content collection in Blackboard Learn. This endpoint allows developers to access detailed information about a particular resource, such as a document, video, or other educational…
Retrieves the course goal alignments for a specified course in Blackboard. This endpoint allows users to fetch detailed information about how course goals are linked to specific learning objectives within a particular…
Retrieves a specific file associated with a student's attempt in a course's gradebook within the Blackboard Learn system. This endpoint allows authorized users, such as instructors or administrators, to access…
Retrieves detailed information about a specific child course within a parent course in the Blackboard Learn platform. This endpoint is useful for accessing hierarchical course structures, allowing developers to fetch…
Retrieves detailed information about a specific criterion within an adaptive release rule for a particular content item in a Blackboard Learn course. This endpoint allows instructors or administrators to examine the…
Retrieves the adaptive release rules associated with a specific content item within a Blackboard course. This endpoint allows instructors or administrators to view the conditions under which the content becomes…
Retrieves specific content within a Blackboard course using the course ID and content ID. This endpoint allows users to access detailed information about a particular content item, such as a lecture, assignment, or…
Retrieves a list of child content items for a specific content within a Blackboard Learn course. This endpoint is used to navigate the hierarchical structure of course materials, allowing users to explore sub-items or…
Retrieves the groups associated with a specific content item within a Blackboard course. This endpoint is useful for understanding the group structure or permissions related to particular course content. It should be…
Retrieves the criteria associated with a specific adaptive release rule for a particular content item within a Blackboard course. This endpoint allows instructors or administrators to view the conditions that must be…
Retrieves the contents of a specific course in the Blackboard Learn platform. This endpoint allows you to fetch all learning materials, resources, and content items associated with a given course. It should be used…
Retrieves detailed information about a specific course in the Blackboard Learn system. This endpoint is used to access course data such as title, description, availability, enrollment information, and other…
Retrieves detailed information about a specific course in the Blackboard Learning Management System. This endpoint allows users to fetch comprehensive data related to a course, such as its title, description, start and…
Retrieves detailed information about a specific grade notation within a course's gradebook in the Blackboard Learning Management System. This endpoint allows users to fetch individual grade notation data, which may…
Retrieves the list of gradebook categories for a specific course in the Blackboard learning management system. This endpoint allows users to fetch the organizational structure of a course's gradebook, including the…
Retrieves attempt data for a specific gradebook column within a Blackboard course. This endpoint allows instructors and administrators to access detailed information about student attempts on assignments, tests, or…
Retrieves the gradebook periods for a specified course in the Blackboard learning management system. This endpoint allows users to fetch information about the temporal structure of grade entries and assessments within…
Retrieves detailed information about a specific group within a particular course in the Blackboard learning management system. This endpoint is used to access group data, which may include the group's name…
Retrieves detailed information about a specific group set within a course in the Blackboard learning management system. This endpoint allows users to fetch the properties and configuration of a particular group set…
Retrieves all group sets associated with a specific course in the Blackboard learning management system. Group sets are collections of groups within a course that can be used for various collaborative activities, such…
Retrieves a list of courses from the Blackboard Learn platform. This endpoint allows developers to fetch information about courses available in the learning management system. It can be used to integrate course data…
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…
Retrieves a list of message folders for a specific course in the Blackboard learning management system. This endpoint allows users to access the organizational structure of course messages, providing an overview of how…
Retrieves a list of nodes (modules or units) for a specific course in the Blackboard learning management system. This endpoint allows developers to access the structure and content organization of a course, enabling…
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…
Retrieves detailed information about a specific course role in Blackboard Learn using its unique identifier. This endpoint is used to fetch the properties, permissions, and settings associated with a particular role…
Retrieves the associations of a specific rubric within a given course in Blackboard Learn. This endpoint allows users to fetch information about how a particular rubric is linked to various course elements such as…
Retrieves detailed information about a specific discussion thread within a course on the Blackboard Learn platform. This endpoint allows users to access the content, metadata, and other relevant details of a…
Retrieves a list of courses associated with a specific node in the institutional hierarchy of Blackboard. This endpoint is used to fetch all courses linked to a particular organizational unit (such as a department…
Retrieves all replies to a specific message within a discussion thread of a course in the Blackboard learning management system. This endpoint allows users to access the responses and interactions related to a…
Retrieves detailed information about a specific learning goal within the Blackboard Learn platform. This endpoint allows educators and administrators to access comprehensive data about an individual goal, including its…
Retrieves detailed information about a specific goal set within the Blackboard Learning Management System. This endpoint allows educators and administrators to access comprehensive data about a particular collection of…
Retrieves a list of goal sets from the Blackboard Learn platform. This endpoint allows users to fetch collections of goals, which are likely used for organizing and categorizing educational objectives within the…
Retrieves detailed information about a specific attempt for a gradebook column within a course in the Blackboard Learn system. This endpoint allows users to access individual submission data, such as scores, comments…
Retrieves attempt data for a specific gradebook column within a course in the Blackboard Learn platform. This endpoint allows users to access detailed information about student attempts for a particular assessment or…
Retrieves detailed information about a specific gradebook category within a course in the Blackboard learning management system. This endpoint allows users to access important data about how grades are organized and…
Retrieves detailed information about a specific gradebook column within a particular course in the Blackboard learning management system. This endpoint allows users to access the properties and settings of an…
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…
Retrieves active login sessions for users in the Blackboard learning management system. This endpoint is used to monitor and manage current user sessions across the platform. It provides a list of all ongoing login…
Retrieves detailed information about a specific LTI (Learning Tools Interoperability) domain within the Blackboard Learn system. This endpoint is used to fetch configuration details, status, and other relevant…
Retrieves a list of LTI (Learning Tools Interoperability) domains registered with the Blackboard Learn platform. This endpoint is used to obtain information about the external tools and platforms that have been…
Retrieves detailed information about a specific LTI (Learning Tools Interoperability) placement within the Blackboard Learn platform. This endpoint allows developers and administrators to fetch the configuration…
Retrieves the list of administrators associated with a specific node in the Blackboard institutional hierarchy. This endpoint is used to fetch administrative information for a particular organizational unit, such as a…
Retrieves a list of observees associated with a specific user in the Blackboard learning management system. This endpoint is used to fetch information about individuals or entities that the specified user is authorized…
Retrieves a list of participants for a specific message within a Blackboard course. This endpoint allows users to access information about who is involved in a particular course message, which can be useful for…
Retrieves detailed information about a specific proctoring service integrated with Blackboard Learn. This endpoint allows users to fetch configuration details, availability status, and other relevant information for a…
Retrieves a list of available proctoring services integrated with the Blackboard Learn platform. This endpoint is part of Blackboard's Proctoring Services Framework and is designed to support online examination…
Retrieves the list of available pronouns in the Blackboard learning management system. This endpoint is used to fetch the predefined set of pronouns that users can choose from when setting up or updating their profile…
Retrieves detailed information about a specific rubric association within a Blackboard Learn course. This endpoint allows users to access the configuration and application details of a rubric to a particular assessment…
Retrieves the evaluations associated with a specific rubric for a particular course and rubric association in the Blackboard learning management system. This endpoint is designed for instructors, administrators, or…
Retrieves detailed information about a specific rubric evaluation within a Blackboard course. This endpoint allows users to access the assessment data, including scores and feedback, for a particular rubric evaluation…
Retrieves the rubric evaluations for a specific attempt on a gradebook item within a Blackboard course. This endpoint allows instructors or administrators to access detailed rubric-based assessment data for a…
Retrieves a specific Student Information System (SIS) dataset from the Blackboard Learn platform using its unique identifier. This endpoint is used to access detailed information about a particular SIS dataset, which…
Retrieves detailed information about a specific system role in the Blackboard learning management system. This endpoint should be used when you need to access the properties, permissions, or other attributes associated…
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…
Retrieves detailed information about a specific system task in the Blackboard Learn platform. This endpoint allows developers to fetch the current status, details, and metadata of an individual task identified by its…
Retrieves detailed information about a specific academic term in the Blackboard Learn system. This endpoint is used to fetch comprehensive data about a term, such as its name, start date, end date, and any associated…
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…
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…
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…
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…
Retrieves detailed information about a specific user's membership or role within a group in a particular course on the Blackboard platform. This endpoint is used to access user-specific data in the context of their…
Retrieves a specific user's grade for a particular gradebook column in a Blackboard course. This endpoint is useful for accessing individual student performance data within a course, allowing for targeted grade…
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…
Retrieves the grades for all users associated with a specific gradebook column in a particular Blackboard course. This endpoint is useful for instructors or administrators who need to access and analyze grade data for…
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…
Retrieves detailed information about a specific user's participation or engagement in meetings for a particular course within the Blackboard learning management system. This endpoint is useful for instructors…
Retrieves the active or historical sessions for a specific user in the Blackboard Learn platform. This endpoint allows developers to access detailed information about a user's interaction with the system, including…
Retrieves a list of users enrolled in a specific course within the Blackboard learning management system. This endpoint is used to access information about students, instructors, and other roles associated with a…
Retrieves a list of users associated with a specific node in the Blackboard Learn institutional hierarchy. This endpoint allows administrators and authorized users to fetch user information within the context of the…
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…
Retrieves detailed information about a specific institutional role in the Blackboard learning management system. This endpoint should be used when you need to access the properties, permissions, or settings associated…
Creates a new attempt for a specific gradebook column in a Blackboard course. This endpoint allows instructors or authorized users to add a new attempt record for a student's assignment or assessment. It can be used to…
Updates the roles of an administrative user for a specific node within the institutional hierarchy of Blackboard. This endpoint allows you to modify the permissions and responsibilities of an admin user by assigning or…
This endpoint allows for updating specific attributes of a gradebook attempt for a particular course, column, and attempt ID. It is used to modify various aspects of a student's submission, including its status, score…
Update the Course Meeting Attendance data for the given Course/Organization. The "course.attendance.MODIFY" entitlement is required to update a Course Meeting Attendance. The "course.attendance.VIEW" entitlement is…
Creates or updates attendance records for the meeting for all users in the course. User required both of the entitlements below. If the user does not have the required entitlements,no records are created or modified…
Updates specific details of a category in the Blackboard catalog system. This endpoint allows modification of various category attributes such as title, description, front page visibility, availability, access…
This endpoint updates the relationship between a parent course and its child course in the Blackboard Learning Management System. It is used to modify existing course hierarchies, allowing administrators to restructure…
This endpoint updates the association between a specific content item and a group within a Blackboard Learn course. It is used to modify existing content-group relationships, enabling instructors or administrators to…
This endpoint updates an existing course within a specific category in the Blackboard catalog. It allows administrators or authorized users to modify course details such as title, description, or other attributes…
Updates a specific discussion forum within a Blackboard Learn course. This endpoint allows for partial updates to discussion properties such as title, availability, grading options, and the main topic content. It is…
Updates the properties of an existing group within a specific course in the Blackboard Learn platform. This endpoint allows for modifying various aspects of a group, including its name, description, availability to…
Updates an existing group within a specified course in the Blackboard Learn system. This endpoint allows for modification of various group properties including its external ID, name, description, availability status…
Updates an existing course in the Blackboard Learn system. This endpoint allows modification of various course attributes including basic information, availability settings, enrollment options, and localization…
The PatchCourse endpoint allows for updating specific details and settings of an existing course in the Blackboard Learn system. It is used when modifications to course properties such as name, description…
Updates the read status of a specific message within a Blackboard course. This endpoint allows you to mark a message as read or unread, which can be useful for tracking user engagement or managing message statuses. Use…
This endpoint updates the association between a specific course and a node in the Blackboard institutional hierarchy. It allows you to set or change whether the specified node is the primary association for the given…
Updates the association between a course and a node in the Blackboard Learn institutional hierarchy. This endpoint allows you to modify the primary status of a course-node association. Use this when you need to change…
Updates the visibility settings for a specific Table of Contents (TOC) item within a Blackboard course. This endpoint allows you to modify guest and observer access permissions for a particular TOC item. Use this when…
Updates a specific message within a course discussion on the Blackboard platform. This endpoint allows for modifying the status and/or content of an existing message. It can be used to publish drafts, soft-delete…
This endpoint updates a specific grade column in a course's gradebook. It allows modification of column details, scoring settings, availability, grading options, and rubric associations. Use it to adjust existing…
Updates a specific grading period within a course's gradebook in the Blackboard Learn system. This endpoint allows for modification of various attributes of an existing grading period, including its title, description…
Updates the properties of a specific group within a Blackboard Learn course. This endpoint allows modification of group details such as name, description, availability, and enrollment settings. It's particularly useful…
This endpoint allows for updating specific properties of a node within the institutional hierarchy of Blackboard. It is used to modify existing nodes, enabling administrators to keep the institutional structure…
Updates a user's information or association within a specific node of the institutional hierarchy in Blackboard. This endpoint is used to modify a user's relationship or details within a particular organizational unit…
This endpoint allows updating an existing LTI (Learning Tools Interoperability) domain configuration in the Blackboard Learn platform. It is used to modify various settings related to LTI tool integration, including…
This endpoint allows you to update an existing LTI (Learning Tools Interoperability) placement in the Blackboard learning management system. It provides granular control over various aspects of the placement, including…
Updates the information for a specific pronoun in the Blackboard system. This endpoint allows modification of an existing pronoun's name and status, identified by the pronoun ID in the URL path. It's used to manage the…
Updates the properties of a rubric association within a specific Blackboard course. This endpoint allows for modifying various aspects of how a rubric is associated with course content, including its visibility to…
Updates a specific rubric evaluation for a course in the Blackboard Learning Management System. This endpoint allows for modifying the scores and feedback for individual criteria within a rubric that has been…
This endpoint updates a user-specific criterion within an adaptive release rule for a particular content item in a Blackboard course. It allows for fine-tuning of content visibility based on individual user conditions…
Updates a specific user's grade information within a course's gradebook column in the Blackboard learning management system. This endpoint allows instructors or authorized users to modify various aspects of a student's…
This endpoint updates a user's information within a specific group in a Blackboard course. It allows administrators or instructors to modify user details, roles, or permissions for a particular user in the context of a…
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…
Updates a user's profile in the Blackboard learning management system. This endpoint allows for partial or complete updates to various aspects of a user's account, including personal information, contact details…
Adds a user to a specific meeting within a Blackboard course and sets their attendance status. This endpoint is essential for managing attendance and user participation in course meetings. It allows instructors or…
Updates the observer relationship between a user and an observer in the Blackboard Learn platform. This endpoint is used to modify existing observer connections, such as changing the level of access or updating the…
This endpoint allows for the upload and attachment of files to a specific attempt within a course's gradebook in the Blackboard learning management system. It is used to associate submitted work, supporting documents…
Setup
Pick a scope, then confirm what can start a Protege and what it can do.
What can start a Protege from this app.
What a Protege can do after it starts.
Prefer team for production.
Shared credential for production and unattended runs.
Tied to one user—only when the workflow needs their account.
Team-scoped for supported chat surfaces.
Build with us
Request early access or book a live walkthrough with the team.