Retrieve the list of notes for a guest
This API will help you to retrieve the notes created for the specified guest.
You must specify the unique identifier of the guest as guest_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/guests/{guest_id}/notes
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| guest_id | string | Yes | Mandatory Unique 32-character identifier of the guest. |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| view_private | boolean | No | false | Optional Indicates whether private guest notes can be viewed. Default value is false. |
| view_only_profile_alerts | boolean | No | false | Optional Indicates whether only profile alerts are to be viewed. Default value is false. |
| noteType | integer (int32) | No | -1 | Optional Indicates the type of note. Default value is -1. |
| 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. |
Response
Success (200 OK)
{
"notes": [
{
"...": "..."
}
]
}
Response fields
| Field | Type | Description |
|---|---|---|
| notes | object[] | |
| notes[].id | string | |
| notes[].is_private | boolean | |
| notes[].alert | boolean | |
| notes[].note_type | integer | |
| notes[].notes | string | |
| notes[].center | object | |
| notes[].added_by | object | |
| notes[].created_date | string |
Example
curl --request GET \
--url 'https://api.zenoti.com/v1/guests/{guest_id}/notes' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/guests/{guest_id}/notes', {
method: 'GET',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.get(
'https://api.zenoti.com/v1/guests/{guest_id}/notes',
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/{guest_id}/notes");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/guests/{guest_id}/notes')
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 |