v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Events

Get a single event

Returns detailed information about a specific event.

get/events/v2/events/{eventId}

Path parameters

eventIdstring required

Event ID or event code (e.g., "12345" or "g162795")

Headers

x-property-idstring required

Example:1,2,3

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

Response

Event details

successboolean required

Success status

Example response

{
  "success": true,
  "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"
  }
}