v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve a category

This API helps you to retrieve the details of a category.

You must specify the unique identifier of the location (center) as center_id and the unique identifier of the category as category_id in the API request. The API then retrieves the details of the category.

get/v1/centers/{center_id}/categories/{category_id}?type={type}

Path parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

category_idstring required

Mandatory Unique 32-character identifier of the category.

Query parameters

type'1' | '2' | '3' | '4' | '5' | '6'

Optional Indicates the type of categories: Services - 1, Products - 2, Memberships - 3, Packages - 4. Default value is Services.

Response

200

idstring

codestring

namestring

parent_category_idstring

descriptionstring

html_descriptionstring

show_in_catalogboolean

{"stackTrail":"paths:/v1/centers/{center_id}/categories/{category_id}?type={type}:get:responses:200:content:application/json:schema:properties:display_order","oasType":"schema","type":"unknown"}

Example response

{
  "id": "80e4819c-39d8-46e6-875d-be054c421280",
  "name": "Hair Replacement",
  "parent_category_id": "41ac7424-8bde-461c-9c88-8e794c9ec77b",
  "show_in_catalog": true
}