Category

How categories are represented in Clerk.io

A category is represented as a category object.

**All attribute names must be strings. Attribute values can be, unless specified otherwise: **

  • bool, int, float, string
  • object (nested objects are supported)
  • list containing any of the above types

Note: object values cannot be used for filtering.

They can have any number of attributes but must at least contain the following marked as Required:

AttributeTypeRequiredDescription
idint or strRequiredThe category ID.
namestrRequiredThe category name.
urlstrRequiredThe category URL.
subcategorieslist of int or strRequiredThe IDs of the category's immediate subcategories.
imagestrOptionalAn image representing the category.
descriptionstrOptionalText describing the details of the category.