v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

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.

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

Path parameters

guest_idstring required

Mandatory Unique 32-character identifier of the guest.

note_idstring required

Mandatory Unique 32-character identifier of the guest note.

Response

200

idstring

is_privateboolean

alertboolean

note_typeinteger

notesstring

created_datestring

Example response

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