Retrieve a guest note

GET https://api.zenoti.com/v1/guests/{guest_id}/notes/{note_id}

This API helps you to retrieve the details of the specified guest note.

You must specify the unique identifier of the guest as guest_id and the note as note_id in the API request.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

GET /v1/guests/{guest_id}/notes/{note_id}

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.
note_id string Yes Mandatory Unique 32-character identifier of the guest note.

Response

Success (200 OK)

{
  "id": "5569e7f4-7710-4773-aeba-6f30c225f46f",
  "is_private": false,
  "alert": true,
  "note_type": 8,
  "notes": "sample string 4",
  "center": {
    "id": "c56f4e05-62b5-4033-b42e-b72db37722df",
    "name": "London"
  },
  "added_by": {
    "id": "",
    "name": ""
  },
  "created_date": "2018-12-20T10:56:22"
}

Response fields

Field Type Description
id string
is_private boolean
alert boolean
note_type integer
notes string
center object
center.id string
center.name string
added_by object
added_by.id string
added_by.name string
created_date string

Example

curl --request GET \
  --url 'https://api.zenoti.com/v1/guests/{guest_id}/notes/{note_id}' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/guests/{guest_id}/notes/{note_id}', {
  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/{note_id}',
    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/{note_id}");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/guests/{guest_id}/notes/{note_id}')
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