List all packages of a center
This API helps you to retrieve all the packages that are active in the center. You must specify the unique identifier of the center as center_id in the API request.You can also use the pagination feature by passing page and size query parameters if you have a large number of records to be displayed. By default, page is set as 1 and size is set as 10. size cannot be more than 100: which means that the maximum records per page cannot be more than 100.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
GET /v1/centers/{center_id}/packages
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| center_id | string | Yes | Mandatory Unique 32-character identifier of the center. |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| appointment_date | string (date) | No | — | Optional Date of the appointment. |
| type | enum () | No | — | Optional Indicates the type of package: DayPackage - 1, SeriesPackage - 2, PromoPackage - 3. |
| excludeServices | boolean | No | — | Optional Indicates whether any services are to be excluded from the package. |
| blockServiceLevelTaxPackages | boolean | No | — | Optional Indicates whether any service-level tax packages are to be blocked. |
| page | integer (int32) | No | 1 | Optional Number of the display page. Default value is 1. |
| size | integer (int32) | No | 10 | Optional Number of records per page. Default value is 10. |
| show_in_catalog | boolean | No | — | Optional Indicates whether the package is displayed on the Catalog tab. Default value is false. |
| expand | string | No | — | Expands specific sections of the package details such as centers, catalog_info, preferences, benefits, tags. |
| category_id | integer (int32) | No | — | Filter packages by category. |
| search_text | string | No | null | Text filter to search packages by name or description. |
| is_active | boolean | No | false | Returns only active packages when true. |
| PackageType | enum () | No | null | Filters results by package type (e.g., Day, Series, Promo). |
| series_package_type | enum () | No | null | Type of the series package (e.g., Regular, Offer, Custom). |
| member_price | boolean | No | false | Include member pricing in the response. Returns discount_price for eligible guests. |
| guest_id | integer (int32) | No | null | Guest identifier to determine member pricing when using an API key. Must be used with member_price=true. |
| is_giftcard_enabled | boolean | No | false | Include only day packages that can be sold as gift cards. |
Response
Success (200 OK)
{}
Example
curl --request GET \
--url 'https://api.zenoti.com/v1/centers/{center_id}/packages' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/centers/{center_id}/packages', {
method: 'GET',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.get(
'https://api.zenoti.com/v1/centers/{center_id}/packages',
headers={
'Authorization': 'bearer {{access_token}}',
},
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
"https://api.zenoti.com/v1/centers/{center_id}/packages");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/centers/{center_id}/packages')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)
Error codes
| Status | Description |
|---|---|
| 400 | 400 |
| 401 | Unauthorized -- invalid or expired access token |
| 429 | Too many requests -- rate limit exceeded |