v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Events

List notes for an event

Returns a paginated list of notes for a specific event.

get/events/v2/events/{eventId}/notes

Path parameters

eventIdstring required

Event ID or event code

Query parameters

limitinteger

offsetinteger

includeArchivedboolean

Headers

x-property-idstring required

Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Response

List of notes

successboolean required

Success status

offsetinteger required

Number of items skipped (pagination offset)

limitinteger required

Maximum number of items returned

Example response

{
  "success": true,
  "limit": 100,
  "data": [
    {
      "id": "144",
      "eventId": "12345",
      "text": "Guest requested late checkout for the wedding party",
      "createdBy": "John Smith",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z",
      "archivedAt": "2025-01-20T14:45:00Z"
    }
  ]
}