Retrieve the details of all the members of a center
This API helps you to retrieve the list of memebers in the specified 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}/members
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 |
|---|---|---|---|---|
| created_date | string (date) | No | — | Optional Date on which the membership was created. |
| last_updated_date | string (date) | No | — | Optional Date on which the membership was last updated. |
| 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. |
| status | enum () | No | — | Optional Indicates the status of the membership: all - -1, active - 1, inactive - 2, frozen - 3, cancelled - 4, expired - 5, closed - 6, not_started - 7, suspended - 8, refund - 9, deleted - 10, failed - 12. |
Response
Success (200 OK)
{
"members": [
{
"...": "..."
}
],
"page_info": {
"total": 30,
"page": 1,
"size": 10
}
}
Response fields
| Field | Type | Description |
|---|---|---|
| members | object[] | |
| members[].id | string | |
| members[].status | string | |
| members[].guest | object | |
| members[].membership | object | |
| members[].start_date | string | |
| members[].end_date | string | |
| members[].sold_date | string | |
| members[].recurrence_status | string | |
| members[].renewal_details | object | |
| members[].freeze_date | object | |
| members[].cancelled_date | object | |
| members[].closed_date | object | |
| members[].credits_amount | integer | |
| members[].services_amount | integer | |
| members[].products_amount | integer | |
| page_info | object | |
| page_info.total | integer | |
| page_info.page | integer | |
| page_info.size | integer |
Example
curl --request GET \
--url 'https://api.zenoti.com/v1/centers/{center_id}/members' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/centers/{center_id}/members', {
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}/members',
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}/members");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/centers/{center_id}/members')
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 |