Teams are named groups of members. Assigning a course to a team enrolls every member of the team in it, and members added to the team later are enrolled in every course the team is assigned to.
Search Teams
Searches the teams in your organization by name or description.
query Parameters
qThe text to search for in the team name or description.
The text to search for in the team name or description.
pageA cursor for pagination across multiple pages of results.
A cursor for pagination across multiple pages of results.
limitA limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
A limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
Headers
AuthorizationContent-TypeAcceptSearch Teams › Responses
errorpayloadUpdate a Team
Updates the name, description or tag behaviour of a team. Only the parameters you send are changed.
path Parameters
idThe ID of the team.
Headers
AuthorizationContent-TypeAcceptUpdate a Team › Request Body
nameThe team name. Must not be greater than 255 characters.
descriptionA short description of the team.
assign_tagWhen true, members added to the team are tagged with the team name in every course the team is assigned to.
Update a Team › Responses
errorpayloadDelete a Team
Deletes a team. By default its members keep the course access they gained through the team; send revoke_course_access to remove them from those courses as well.
path Parameters
idThe ID of the team.
Headers
AuthorizationContent-TypeAcceptDelete a Team › Request Body optional
revoke_course_accessWhen true, the team members are also removed from every course the team was assigned to. Defaults to false: the team is deleted and its members keep their course access.
Delete a Team › Responses
errorpayloadList all Teams
Returns a paginated list of the teams in your organization, newest first.
query Parameters
pageA cursor for pagination across multiple pages of results.
A cursor for pagination across multiple pages of results.
limitA limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
A limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
Headers
AuthorizationContent-TypeAcceptList all Teams › Responses
errorpayloadCreate a Team
Creates a new team in your organization. Assign members and courses with the assign endpoints.
Headers
AuthorizationContent-TypeAcceptCreate a Team › Request Body
nameThe team name. Must not be greater than 255 characters.
descriptionA short description of the team.
assign_tagWhen true, members added to the team are tagged with the team name in every course the team is assigned to. Defaults to false.
Create a Team › Responses
errorpayloadList Team Members
Returns a paginated list of the members of a team. Each item is the assignment, with the member and the team nested.
path Parameters
idThe ID of the team.
query Parameters
include_test_userInclude test users in the list. Defaults to false.
Include test users in the list. Defaults to false.
pageA cursor for pagination across multiple pages of results.
A cursor for pagination across multiple pages of results.
limitA limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
A limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
Headers
AuthorizationContent-TypeAcceptList Team Members › Responses
errorpayloadList Team Courses
Returns a paginated list of the courses assigned to a team. Each item is the assignment, with the course and the team nested.
path Parameters
idThe ID of the team.
query Parameters
pageA cursor for pagination across multiple pages of results.
A cursor for pagination across multiple pages of results.
limitA limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
A limit on the number of objects to be returned, between 1 and 100. Defaults to 10.
Headers
AuthorizationContent-TypeAcceptList Team Courses › Responses
errorpayloadAssign a Member to a Team
Assigns a member of your organization to the team and enrolls them in every course the team is assigned to. Assigning a member who is already in the team has no effect.
path Parameters
idThe ID of the team.
Headers
AuthorizationContent-TypeAcceptAssign a Member to a Team › Request Body
memberThe ID of the member to assign to the team. The member is enrolled in every course the team is assigned to.
Assign a Member to a Team › Responses
errorpayloadUnassign a Member from a Team
Unassigns a member from the team. By default the member keeps the course access they gained through the team; send revoke_course_access to remove them from those courses as well.
path Parameters
idThe ID of the team.
Headers
AuthorizationContent-TypeAcceptUnassign a Member from a Team › Request Body
memberThe ID of the member to unassign from the team.
revoke_course_accessWhen true, the member is also removed from every course the team is assigned to. Defaults to false: the member keeps the course access they gained through the team.
Unassign a Member from a Team › Responses
errorpayloadAssign a Course to a Team
Assigns a course of your organization to the team and enrolls every current team member in it. Assigning a course that is already assigned has no effect.
path Parameters
idThe ID of the team.
Headers
AuthorizationContent-TypeAcceptAssign a Course to a Team › Request Body
courseThe ID of the course to assign to the team. Every current team member is enrolled in it, and members assigned later are enrolled on assignment.
Assign a Course to a Team › Responses
errorpayloadUnassign a Course from a Team
Unassigns a course from the team. By default the team members keep their access to the course; send revoke_course_access to remove them from it as well.
path Parameters
idThe ID of the team.
Headers
AuthorizationContent-TypeAcceptUnassign a Course from a Team › Request Body
courseThe ID of the course to unassign from the team.
revoke_course_accessWhen true, the team members are also removed from the course. Defaults to false: the course is detached from the team and members keep their access.
Unassign a Course from a Team › Responses
errorpayload