Retrieve a guest note

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Details

NameTypeDescription
idguidUnique 32-character identifier of the guest note.
is_privatebooleanIndicates whether the note is private.
alertbooleanIndicates whether the guest note alert is active.
note_typeenumType of the guest note: Unknown - 0, Generic - 2, Checkin - 3, Booking - 4, Payment - 8, Profile - 10
notesstringMessage inside the note.
centerobjectObject that contains the details of the center.
added_byobjectObject that contains the added by details.
created_datedatetimeDate on which the note was created.
is_post_to_pmsbooleanIndicates whether the chkPostToPms check box has been selected.
post_to_pms_response_messagestringError message for ChkPostToPMS.
entity_pkintEntity For which the notes is added.
entity_namestringEntity Name For which the note is added.
Path Params
string
required
Defaults to d6cfc4ed-f7b6-454a-a8cd-36a67a324e57

Mandatory Unique 32-character identifier of the guest.

string
required
Defaults to d6cfc4ed-f7b6-454a-a8cd-36a67a324e57

Mandatory Unique 32-character identifier of the guest note.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json