v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Integration Events

Get a list of integration events for a specific property.

get/integration/v1/events

Query parameters

A string specifying fields for sorting with optional directions (e.g., asc or desc).

{
  "sort": {
    "fields": [
      {
        "field": "checkin_date"
      }
    ]
  }
}

limitinteger

The maximum number of items to return in the response. Default is 100.

offsetinteger

The number of items to skip before starting to collect the result set. Used for pagination.

This parameter should be formatted as a list of strings separated by ;

{
  "filters": {
    "and": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ],
    "or": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ]
  }
}

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 integration events.

totalinteger required

The total number of items available

Example response

{
  "data": [
    {
      "id": "123456",
      "propertyId": "123456",
      "objectId": "123456",
      "objectType": "reservation",
      "system": "gov",
      "status": "open",
      "result": "success",
      "description": "Integration event description.",
      "details": "Integration event details.",
      "actionText": "Retry",
      "createdAt": "2023-10-01T12:00:00Z",
      "updatedAt": "2023-10-01T12:00:00Z",
      "retriedAt": "2023-10-01T12:00:00Z"
    }
  ],
  "total": 100
}