ClientCategory
List client categories
Get a list of client categories for the specified business id. List can be filtered by name and possibility to include archived client categories as well as an option to list only archived client categories
get/api/business/{businessId}/category/client
Path parameters
businessIdstring required
Query parameters
namestring
client category name to filter by
archivedOnlyboolean
include archived client categories in the list
number of client category records to return, max is 100
page number, default is 0 and is optional
Response
Client categories listed
Example response
{
"_embedded": {
"clientCategories": [
{
"categoryId": "ab123",
"name": "Loyal Customer",
"description": "Has made many visits"
}
]
}
}