Skip to Content
API ReferenceCategoriesCategory Object

The category object

The category object is a JSON object with the following properties:

{ "id": string, "title": string, "slug": string, "description": string, "workspace": string, "parent": object | string, // absent on a root category "path": [ { "id": string, "doc": string, // category id this crumb points at; sometimes absent on create "url": string, "label": string } ], "pathLabel": string, // breadcrumb titles joined with " / " "videoCount": number, "videoCountWithSubcategories": number, "createdAt": Date, "updatedAt": Date }

parent is the parent category. With the default depth it is a category object. With depth=0 it is an id. A root category omits parent. path is the breadcrumb. pathLabel joins those titles with /. videoCount is the number of videos in this category. videoCountWithSubcategories includes videos in child categories.

Writable fields are title (max 100), slug, description (max 2000), and parent (a category id). When you create a category without slug, it is generated from title.