v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

List all categories

This API helps you to retrieve the list of categories that are active in a center. You must specify the unique identifier of the location (center) in the API request as center_id.

get/v1/centers/{center_id}/categories

Path parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

Query parameters

pageinteger

Optional Number of the results page. Default value is 1.

sizeinteger

Optional Number of records to be displayed on a page. Default value is 10.

show_in_catalogboolean

Optional Indicates whether the category is displayed in the catalog. Default value is false.

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.

include_sub_categoriesboolean

Optional Indicates whether sub-categories are to included in the API response. Default value is false.

Response

200

Example response

{
  "categories": [
    {
      "id": "6cba62cc-dcf1-45e2-a22e-630ce0de5923",
      "name": "a vcwd",
      "description": "sagffh"
    }
  ],
  "page_Info": {
    "total": 2,
    "page": 1,
    "size": 10
  }
}