Property Health
Retrieve property health for the provider context
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 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
},
"compliance": {
"kypStatus": "APPROVED",
"dsaStatus": "REQUESTED"
},
"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"
},
"reservations": {
"gross": 10,
"cancelled": 2,
"net": 8
},
"dataAsOf": "2026-02-17T06:45:00Z"
}
],
"meta": {
"ruid": "ruid-1"
}
}