BObooking
Property Health

Retrieve property health for the provider context

Changed on

Returns property health records for properties available in the authenticated provider context. The provider-context lookup returns up to 2,000 eligible properties selected by backend priority rules, prioritizing actionable health and status signals before applying deterministic property ID ordering. The filterBy field narrows results using supported field enum values.

post/properties/health

Request

Request body

Example request

{
  "filterBy": [
    {
      "field": "STATUS_CURRENT_STATUS",
      "operator": "EQUALS",
      "value": "Open"
    },
    {
      "field": "PROPERTY_INFO_CURRENCY_CODE",
      "operator": "EQUALS",
      "value": "EUR"
    },
    {
      "field": "AVAILABILITY_BOOKABLE_UNTIL_DATE",
      "operator": "GREATER_THAN_OR_EQUALS",
      "value": "2026-12-31"
    }
  ]
}

Response

Successful response containing property health records.

Example response

{
  "properties": [
    {
      "status": {
        "currentStatus": "Open",
        "statusChangedAt": "2026-02-10T09:00:00Z",
        "statusDescription": "Your property is live and accepting bookings.",
        "timeInStatusDays": 30
      },
      "availability": {
        "risk": "NO_RISK",
        "bookableUntilDate": "2026-12-31",
        "bookablePeriod": 317,
        "reason": "Availability is open well into the future. No action is needed if your property is open."
      },
      "propertyId": 1000123,
      "propertyInfo": {
        "propertyName": "Canal View Hotel",
        "currencyCode": "EUR"
      },
      "dataAsOf": "2026-02-17T06:45:00Z"
    }
  ],
  "meta": {
    "ruid": "ruid-1"
  }
}

Changes

  • e862539b03c2Revision changes
    • breaking

      removed the enum value COMPLIANCE_DSA_STATUS of the request property //

    • breaking

      removed the enum value COMPLIANCE_KYP_STATUS of the request property //

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status