API Reference

List all categories

get
https://api.zenoti.com/v1/centers//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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Details

NameTypeDescription
categoriesobjectObject that contains the list of all CategoryInfo-related elements.
page_infoobjectObject that contains the elements related to the category records displayed on a page.
errorobjectObject that contains error message and error code details. For more information, refer to the error Object table.

error Object

codemessage
502Invalid center_id.
Path Params
string
required

Mandatory Unique 32-character identifier of the center.

Query Params
int32
Defaults to 1

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

int32
Defaults to 10

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

boolean

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

string
enum
Defaults to 1

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

Allowed:
boolean

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

Responses

Updated over 3 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 3 years ago