Generate a guest report
Generates a report of guest activity including visit frequency, spend totals, and retention metrics.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (under Administrator) — Required to access Zenoti APIs.
Endpoint
POST /v1/reports/guests
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| center_id | string (GUID) | Yes | Center identifier |
| start_date | date | Yes | Report start date |
| end_date | date | Yes | Report end date |
| page | integer | No | Page number |
| size | integer | No | Records per page (max 100) |
Response
Success (200 OK)
{
"report": {
"total_guests": 1250,
"new_guests": 180,
"returning_guests": 1070,
"guests": [
{
"guest_id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
"name": "Jane Smith",
"visits": 8,
"total_spend": 1044.00
}
]
},
"page_info": { "total": 1250, "page": 1, "size": 10 },
"error": null
}
Response fields
| Field | Type | Description |
|---|---|---|
| report.total_guests | integer | Total unique guests |
| report.new_guests | integer | First-time guests |
| report.returning_guests | integer | Returning guests |
| report.guests | array | Individual guest details |
Example
curl --request POST \
--url 'https://api.zenoti.com/v1/reports/guests' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"center_id": "a3614939-16c0-4a7b-bc33-a69b106d855c",
"start_date": "2026-03-01",
"end_date": "2026-03-31"
}'
const response = await fetch('https://api.zenoti.com/v1/reports/guests', {
method: 'POST',
headers: {
'Authorization': 'bearer {{access_token}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({ center_id: 'a3614939-16c0-4a7b-bc33-a69b106d855c', start_date: '2026-03-01', end_date: '2026-03-31' })
});
const data = await response.json();
import requests
response = requests.post(
'https://api.zenoti.com/v1/reports/guests',
headers={
'Authorization': 'bearer {{access_token}}',
},
json={'center_id': 'a3614939-16c0-4a7b-bc33-a69b106d855c', 'start_date': '2026-03-01', 'end_date': '2026-03-31'}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
JsonSerializer.Serialize(new { centerId = "a3614939-16c0-4a7b-bc33-a69b106d855c", startDate = "2026-03-01", endDate = "2026-03-31" }),
Encoding.UTF8, "application/json");
var response = await client.PostAsync(
"https://api.zenoti.com/v1/reports/guests", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/reports/guests')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { center_id: 'a3614939-16c0-4a7b-bc33-a69b106d855c', start_date: '2026-03-01', end_date: '2026-03-31' }.to_json
response = http.request(request)
data = JSON.parse(response.body)
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.zenoti.com/v1/reports/guests');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: bearer {{access_token}}',
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['center_id' => 'a3614939-16c0-4a7b-bc33-a69b106d855c', 'start_date' => '2026-03-01', 'end_date' => '2026-03-31']));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
Error codes
| Status | Description |
|---|---|
| 400 | Bad request — invalid or missing required fields |
| 401 | Unauthorized — invalid or expired access token |
| 429 | Too many requests — rate limit exceeded (60/min) |