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 leverage 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.

Response Details

NameTypeDescription
notesobjectObject that contains all the notes-related elements.
page_infoobjectObject that contains all the pagination-related elements.
page_detailsobjectObject that contains all the page display-related elements.
Path Params
string
required
Defaults to d6cfc4ed-f7b6-454a-a8cd-36a67a324e57

Mandatory Unique 32-character identifier of the guest.

Query Params
boolean
Defaults to false

Optional Indicates whether private guest notes can be viewed. Default value is false.

boolean
Defaults to false

Optional Indicates whether only profile alerts are to be viewed. Default value is false.

int32
Defaults to -1

Optional Indicates the type of note. Default value is -1.

int32
Defaults to 1

Optional Number of the display page. Default value is 1.

int32
Defaults to 10

Optional Number of records per page. Default value is 10.

Responses

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