Guest Membership Change Log
This API helps you to retrieve the changes to the Guest's Membership, in the specified window.
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/guests/memberships/change_log
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| center_id | string | No | — | Optional Unique identifier of the center for which the guest membership records are to be retrieved. |
| guest_id | string | No | — | Optional Unique identifier of the guest whose guest membership records are to be returned |
| start_date | string (date) | No | — | Optional Records are returned from this start date (yyyy-mm-dd). 00:00:00 is appended to the date value, if no time given. In absence of both date and time, start date is considered as current time minus 7 days. The Time value is displayed in UTC. |
| end_date | string (date) | No | — | Optional Records are returned until this end date (yyyy-mm-dd). 00:00:00 is appended to the date value, if no time given. In absence of both date and time, end date is considered as current time. The Time value is displayed in UTC. |
| page | integer (int32) | No | 1 | Optional Number of display page for the records. Default value is 1. |
| size | integer (int32) | No | 10 | Optional Number of records displayed per page. Default value is 10. |
Response
Success (200 OK)
{
"change_log": [
{
"...": "..."
}
],
"page_info": {
"total": 4,
"page": 1,
"size": 10
},
"error": {}
}
Response fields
| Field | Type | Description |
|---|---|---|
| change_log | object[] | |
| change_log[].guest_id | string | |
| change_log[].id | string | |
| change_log[].status | string | |
| change_log[].recurrence_status | string | |
| change_log[].membership_code | string | |
| change_log[].membership_id | string | |
| page_info | object | |
| page_info.total | integer | |
| page_info.page | integer | |
| page_info.size | integer | |
| error | object |
Example
curl --request GET \
--url 'https://api.zenoti.com/v1/guests/memberships/change_log' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/guests/memberships/change_log', {
method: 'GET',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.get(
'https://api.zenoti.com/v1/guests/memberships/change_log',
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/guests/memberships/change_log");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/guests/memberships/change_log')
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 |