Skip to content

Category

A category, as returned in API responses.

idstring
Example:"cat_123456"
account_idstring
Example:"acc_123456"
descriptionstring, <= 1500 characters
Example:"Standard haircut services"
titlestring, <= 255 characters
Example:"Haircuts"
service_idsArray of strings
Example:
[ "svc_123456" ]
color_codestring, <= 7 characters^#[0-9A-Fa-f]{6}$

Hex color code, e.g. #FF5733.

Example:"#FF5733"
image_urlstring, (uri)
Example:"https://cdn.example.com/categories/haircuts.png"
visibilitystring
Enum:"PUBLIC""PRIVATE""UNAVAILABLE"
Example:"PUBLIC"
{ "id": "cat_123456", "account_id": "acc_123456", "description": "Standard haircut services", "title": "Haircuts", "service_ids": [ "svc_123456" ], "color_code": "#FF5733", "image_url": "https://cdn.example.com/categories/haircuts.png", "visibility": "PUBLIC" }