# 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

 - [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,
 - [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 ar
## About Try it

 - [Environment](https://developers.booking.com/connectivity/docs/openapispecs/property-health-api/property-health-api-specification/about-try-it/environment.md): ## Environment Use a test setup first. The Property Health API is read-only, but live endpoint requests still use real authorization context and return real property health data for properties availab
 - [Authentication](https://developers.booking.com/connectivity/docs/openapispecs/property-health-api/property-health-api-specification/about-try-it/authentication.md): ## Authentication Property Health API requests use token-based authentication. Add an `Authorization` header with a Bearer JWT. Make sure the JWT belongs to a machine account that is configured for th
 - [Request](https://developers.booking.com/connectivity/docs/openapispecs/property-health-api/property-health-api-specification/about-try-it/request.md): ## Request Use `POST /properties/health` to retrieve property health for the authenticated provider context. Send an empty JSON object for an unfiltered lookup, or include `filterBy` to narrow the ret
 - [Filters](https://developers.booking.com/connectivity/docs/openapispecs/property-health-api/property-health-api-specification/about-try-it/filters.md): ## Filters Add `filterBy` to either request type to narrow the result set. Each filter contains `field`, `operator`, and `value`. Multiple filters are combined with AND semantics. The `value` is alway
 - [Response](https://developers.booking.com/connectivity/docs/openapispecs/property-health-api/property-health-api-specification/about-try-it/response.md): ## Response Successful responses include `properties` and `meta`. Each property can include status, property information, availability, compliance, reservation counts, and `dataAsOf`. Some nested sect
 - [Troubleshooting](https://developers.booking.com/connectivity/docs/openapispecs/property-health-api/property-health-api-specification/about-try-it/troubleshooting.md): ## Troubleshooting If a request fails, check that the JWT is valid, the selected machine account is configured for the Property Health API, the property IDs belong to the expected authorization contex