For Developers

Categories Overview

A Category is a container for Assignments, typically visible through the gradebook interface of an LMS. Some systems may refer to it as a "Topic" or a "Tag". It is used to organize and categorize assignments, both for visual clarity and sometimes for grade weighting.

Properties

PropertyTypeDescription
idstringThe UUID for the object.
created_dateDateWhen the object was created in the source.
updated_dateDateWhen the object was last updated in the source.
titlestringThe title of the category.
weightnumberThe weight of the category when calculating grades.
drop_lowestnumberThe number of lowest scores to drop when calculating grades.
positionnumberThe position of the category relative to the others.

Notes

  • Not all providers support category weight, drop_lowest, or position fields, so those fields might be returned as null or not be present in the Category object at all.
  • Google Classroom can be configured to use the premium feature "grade category" or "topic" to map to our Category type.

Supported Providers

ProviderSupport
aerieslist
aspenlist, get, create, update, delete
blackbaudlist, get, create, update, delete
blackboardlist, get
brightspacelist, get, create, update, delete
canvaslist, get, create, update, delete
classgatherlist, get, create, update, delete
googlelist, get, create, update, delete
microsoftlist, get, create, delete
onerosterlist, get, create, update, delete
powerschoollist, get, create, update, delete
schoologylist, get, create, update, delete
skywardlist, get, create, update, delete
veracrosslist
qmlativlist, get, create, update, delete
infinitecampuslist, get, create, update, delete
rapididentitylist, get, create, update, delete
sapphirelist, get, create, update, delete
genesislist, get, create, update, delete
renweblist, get, create, update, delete
synergylist, get
managebaclist