v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

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.

get/v1/guests/{guest_id}/notes?view_private={view_private}&view_only_profile_alerts={view_only_profile_alerts}

Path parameters

guest_idstring required

Mandatory Unique 32-character identifier of the guest.

Query parameters

view_privateboolean

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

view_only_profile_alertsboolean

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

noteTypeinteger

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

pageinteger

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

sizeinteger

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

Response

200

Example response

{
  "notes": [
    {
      "id": "da60c80d-75ad-4ea3-9046-81cec2e54587",
      "is_private": true,
      "note_type": 2,
      "notes": "sample string 4",
      "center": {
        "id": "c56f4e05-62b5-4033-b42e-b72db37722df",
        "name": "London"
      },
      "added_by": {
        "name": " "
      },
      "created_date": "2018-12-20T13:23:29"
    }
  ]
}