{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-connectivity/docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Property Health API overview","siteUrl":"https://developers.booking.com","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"property-health-api-overview","__idx":0},"children":["Property Health API overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Property Health API to retrieve health information for properties connected to your provider account."," ","The API helps you identify properties that may need attention and can support dashboards, monitoring tools, and operational workflows."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-you-can-do-with-property-health-api","__idx":1},"children":["What you can do with Property Health API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With the Property Health API, you can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve health information for properties connected to your provider account."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve health information for specific Booking.com property IDs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Narrow results by filtering on supported property health fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For property-ID requests, identify requested property IDs that could not be returned."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use request metadata to help Booking.com support investigate issues."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full API schema, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connectivity/docs/openapispecs/property-health-api/property-health-api-specification"},"children":["Property Health API OpenAPI specification"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"about-try-it","__idx":2},"children":["About Try it"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Try it to send test requests directly from the developer portal. When using a live endpoint, use only test properties and valid JWT credentials for a machine account that has access to those properties."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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 available to the selected machine account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Property Health API requests use token-based authentication. Add an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header with a Bearer JWT. Make sure the JWT belongs to a machine account that is configured for the Property Health API and has access to the test properties you use."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not use Try it with live JWTs on shared computers or in browsers with extensions that can inspect or monitor network traffic. Treat JWTs as credentials, and remove them from the browser environment after testing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use Try it with both supported requests:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /properties/health"]}," to retrieve property health for the authenticated provider context. Send an empty JSON object for an unfiltered lookup, or include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterBy"]}," to narrow the returned properties."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /properties/health/by-type/property-ids"]}," to retrieve property health for specific Booking.com property IDs. Provide ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["propertyIds"]}," with up to 2,000 IDs. You can also include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterBy"]}," to narrow the returned health records."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Successful responses include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta"]},". Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta.ruid"]}," when contacting Booking.com support."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":3},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before using the Property Health API, make sure that:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You can authenticate with Booking.com Connectivity APIs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your machine account has access to the properties you want to retrieve."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information about authentication, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connectivity/docs/authentication"},"children":["Authentication"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-actions","__idx":4},"children":["Supported actions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table summarises the tasks, HTTP method, and endpoints that the API supports."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Task"},"children":["Task"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP method"},"children":["HTTP method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve property health for your provider account."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/properties/health"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve property health for specific property IDs."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/properties/health/by-type/property-ids"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-property-health-for-your-provider-account","__idx":5},"children":["Retrieve property health for your provider account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this request to retrieve property health information for properties available to your provider account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response contains up to 2,000 eligible properties selected by backend priority rules. The selection prioritizes actionable health and status signals, then applies deterministic property ID ordering where applicable."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://supply-xml.booking.com/property-health-api/properties/health\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send an empty JSON object as the request body:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterBy"]}," to narrow the returned properties. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connectivity/docs/property-health-api/filtering-property-health-results"},"children":["Filtering property health results"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-property-health-for-specific-property-ids","__idx":6},"children":["Retrieve property health for specific property IDs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this request to retrieve property health information for specific Booking.com property IDs."," ","You can request up to 2,000 property IDs and can include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterBy"]}," to narrow the returned properties. For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connectivity/docs/property-health-api/filtering-property-health-results"},"children":["Filtering property health results"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response only includes properties that can be returned for your machine account and have available health data. Requested property IDs that could not be returned or are not linked to the machine account ID are listed in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notFoundIds"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://supply-xml.booking.com/property-health-api/properties/health/by-type/property-ids\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following is an example request body:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"propertyIds\": [\n    1000123,\n    1000456\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterBy"]}," in the same request to narrow the returned health records for the requested property IDs:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"propertyIds\": [\n    1000123,\n    1000456\n  ],\n  \"filterBy\": [\n    {\n      \"field\": \"STATUS_CURRENT_STATUS\",\n      \"operator\": \"EQUALS\",\n      \"value\": \"Open\"\n    },\n    {\n      \"field\": \"AVAILABILITY_RISK\",\n      \"operator\": \"EQUALS\",\n      \"value\": \"NO_RISK\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-body","__idx":7},"children":["Response body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table describes the elements of a successful response body:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Element"},"children":["Element"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains the property health records returned for the request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For property-ID requests, the response can contain fewer properties than requested if some properties are unavailable to the caller or missing from health data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].propertyId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the Booking.com property ID."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].propertyInfo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains basic property information."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].propertyInfo.propertyName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the property name."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].propertyInfo.currencyCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the property currency code."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains current property status information."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].status.currentStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the current property status."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", or the field may be missing entirely"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Possible values include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Open"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["New - Pending Opening"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready to Open"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed - By Your Request"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Auto-Closed - No Availability"]},", and other configured property statuses."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].status.statusChangedAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies when the current status started."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", or the field may be missing entirely"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Uses offset date-time format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].status.statusDescription"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provides the status description."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", or the field may be missing entirely"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Your property is live and accepting bookings."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].status.timeInStatusDays"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the number of days the property has been in the current status."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", or the field may be missing entirely"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].availability"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains availability-related health information when available."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", or the field may be missing entirely"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].availability.risk"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the availability risk category."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Possible values are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HIGH_RISK"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEDIUM_RISK"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LOW_RISK"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NO_RISK"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].availability.bookableUntilDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the last date currently available for booking."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Uses date format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].availability.bookablePeriod"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the number of days until the property becomes unavailable."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].availability.reason"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Explains how the property's future bookable period maps to the availability risk."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Derived from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["risk"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HIGH_RISK"]}," means bookable for 7 days or less, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEDIUM_RISK"]}," for 30 days or less, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LOW_RISK"]}," for 60 days or less, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NO_RISK"]}," for more than 60 days."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].compliance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains compliance-related health information when available."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", or the field may be missing entirely"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].compliance.kypStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the Know Your Partner (KYP) status."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returned by the compliance source. Example values include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REQUESTED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVED"]}," and other KYP lifecycle statuses."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].compliance.dsaStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the Digital Services Act (DSA) compliance status."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returned by the compliance source. Example values include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REQUESTED"]},",",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APPROVED"]}," and other DSA lifecycle statuses."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].reservations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains reservation counts when available."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},", or the field may be missing entirely"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].reservations.gross"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the gross hotel reservation count."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].reservations.cancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the cancelled hotel reservation count."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].reservations.net"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the net hotel reservation count."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties[].dataAsOf"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies when the health snapshot was generated."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Uses offset date-time format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains metadata for the response."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta.ruid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the unique ID of the request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You can send this ID to Booking.com support if you run into an issue."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notFoundIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains requested property IDs that could not be returned or are not linked to the machine account ID."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Included only for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /properties/health/by-type/property-ids"]}," responses."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Successful responses for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /properties/health/by-type/property-ids"]}," can also include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notFoundIds"]},"."," ","This field contains requested property IDs that could not be returned or are not linked to the machine account ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following shows a fully-populated property-ID lookup response example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"properties\": [\n    {\n      \"propertyId\": 1000123,\n      \"propertyInfo\": {\n        \"propertyName\": \"Canal View Hotel\",\n        \"currencyCode\": \"EUR\"\n      },\n      \"status\": {\n        \"currentStatus\": \"Open\",\n        \"statusChangedAt\": \"2026-02-10T09:00:00Z\",\n        \"statusDescription\": \"Your property is live and accepting bookings.\",\n        \"timeInStatusDays\": 30\n      },\n      \"availability\": {\n        \"risk\": \"NO_RISK\",\n        \"bookableUntilDate\": \"2026-12-31\",\n        \"bookablePeriod\": 317,\n        \"reason\": \"Availability is open well into the future. No action is needed if your property is open.\"\n      },\n      \"compliance\": {\n        \"kypStatus\": \"APPROVED\",\n        \"dsaStatus\": \"REQUESTED\"\n      },\n      \"reservations\": {\n        \"gross\": 10,\n        \"cancelled\": 2,\n        \"net\": 8\n      },\n      \"dataAsOf\": \"2026-02-17T06:45:00Z\"\n    }\n  ],\n  \"notFoundIds\": [\n    999999\n  ],\n  \"meta\": {\n    \"ruid\": \"ruid-1\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":8},"children":["Troubleshooting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table lists common response codes and the recommended action:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status code"},"children":["Status code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Recommended action"},"children":["Recommended action"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request is invalid."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check that the request body fields are present and use the correct format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check your authentication credentials and try again."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your machine account cannot use this endpoint or lacks the required authorization context."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check that your machine account is configured to use the Property Health API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No requested property health data can be returned."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check that the request targets properties or provider-context data with available health information."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Too many requests."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retry later. If a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," header is present, wait for the indicated period before retrying."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5xx"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Booking.com could not complete the request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retry later. If the issue continues, contact Booking.com support and include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta.ruid"]}," value."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-actions","__idx":9},"children":["Quick actions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"→ To learn how to authenticate, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connectivity/docs/authentication"},"children":["Authentication"]},"."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"→ To view the full API schema, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connectivity/docs/openapispecs/property-health-api/property-health-api-specification"},"children":["Property Health API OpenAPI specification"]},"."," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"→ Before going live, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connectivity/docs/going_live"},"children":["Going Live"]},"."]}]},"headings":[{"value":"Property Health API overview","id":"property-health-api-overview","depth":1},{"value":"What you can do with Property Health API","id":"what-you-can-do-with-property-health-api","depth":2},{"value":"About Try it","id":"about-try-it","depth":3},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Supported actions","id":"supported-actions","depth":2},{"value":"Retrieve property health for your provider account","id":"retrieve-property-health-for-your-provider-account","depth":2},{"value":"Retrieve property health for specific property IDs","id":"retrieve-property-health-for-specific-property-ids","depth":2},{"value":"Response body","id":"response-body","depth":2},{"value":"Troubleshooting","id":"troubleshooting","depth":2},{"value":"Quick actions","id":"quick-actions","depth":2}],"frontmatter":{"seo":{"title":"Property Health API overview"}},"lastModified":"2026-06-22T11:03:47.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/connectivity/docs/property-health-api/property-health-api-overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}