# Property Health API

Read-only JSON API for connectivity providers to retrieve property health and status data. Use it to understand why properties are unbookable or at risk and to prioritize action across provider-accessible properties or explicit Booking.com property IDs.

Retrieve property health for provider-context and property-ID lookups.

Version: 0.1
License: Copyright Booking.com. All rights reserved.

## Servers

Production Environment
```
https://supply-xml.booking.com/property-health-api
```

## Security

### BearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Property Health API](https://developers.booking.com/_bundle/connectivity/docs/openapispecs/property-health-api/property-health-api-specification.yaml)

## Property Health

Endpoints for retrieving property health and status data.

### Retrieve property health for the provider context

 - [POST /properties/health](https://developers.booking.com/connectivity/docs/openapispecs/property-health-api/property-health-api-specification/property-health/getpropertyhealth.md): 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.

### Retrieve property health by property IDs

 - [POST /properties/health/by-type/property-ids](https://developers.booking.com/connectivity/docs/openapispecs/property-health-api/property-health-api-specification/property-health/getpropertyhealthbypropertyids.md): Returns property health records for the Booking.com property IDs in propertyIds. A request can include up to 2,000 IDs. notFoundIds contains requested property IDs that could not be returned or are not linked to the machine account ID. The filterBy field narrows results using supported field enum values.