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:
Attribute | Type | Required | Description |
---|---|---|---|
id | int or str | Required | The category ID. |
name | str | Required | The category name. |
url | str | Required | The category URL. |
subcategories | list of int or str | Required | The IDs of the category's immediate subcategories. |
image | str | Optional | An image representing the category. |
description | str | Optional | Text describing the details of the category. |