v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Events

List events for a property

Returns a paginated list of events for a property. Events contain operational data and reference group profiles via profileId.

get/events/v2/events

Query parameters

eventCodestring

profileIdstring

statusstring

createdFromstring date-time

createdTostring date-time

startDateFromstring date

startDateTostring date

endDateFromstring date

endDateTostring date

limitinteger

offsetinteger

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 events

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": "12345",
      "eventCode": "g162795",
      "profileId": "987123456489",
      "name": "Smith Wedding Reception",
      "status": "definite",
      "sourceId": "ss-693577",
      "sourceName": "Website/Booking Engine",
      "startDate": "2025-06-15",
      "endDate": "2025-06-17",
      "transactionMode": "post_into_group",
      "transactionTypes": [
        "accommodation",
        "products"
      ],
      "folioConfigId": "456",
      "enableAggregateAllotmentBlock": true,
      "aggregateAllotmentBlockPackageId": "123",
      "segmentId": "5",
      "allotmentBlockCount": 2,
      "reservationsCount": 15,
      "roomsHeld": 20,
      "roomsPickedUp": 15,
      "roomsRemaining": 5,
      "total": {
        "amount": "12439",
        "currencyCode": "USD"
      },
      "grandTotal": {
        "amount": "12439",
        "currencyCode": "USD"
      },
      "paidValue": {
        "amount": "12439",
        "currencyCode": "USD"
      },
      "balanceDue": {
        "amount": "12439",
        "currencyCode": "USD"
      },
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-20T14:45:00Z"
    }
  ]
}