Propertys

Get pet blockout ranges overlapping a stay window

Return blockout ranges that overlap [start, end - 1].

start must be strictly before end and the span must not exceed one year to keep payloads bounded. The response is always a 200 with a (possibly empty) ranges list — there is no 404 for properties that have never configured a schedule, only for missing property ids.

get/properties/{property_id}/pet-blockouts

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/properties/{property_id}/pet-blockouts
  • Auth: none declared

Path parameters

property_idinteger required

Property ID

Query parameters

startstring date required

Stay check-in date (inclusive)

endstring date required

Stay check-out date (exclusive — matches booking convention)

country'AU' | 'NZ'

ISO country code used to scope the public property.

Headers

API-Version'1'

Major API version. Omit or send 1 for the current v1 surface. Retired operations use RFC 9745 Deprecation and RFC 8594 Sunset headers.

Response

Overlapping blockout ranges (possibly empty)

property_idinteger required
startstring date required

Stay check-in date (inclusive)

endstring date required

Stay check-out date (exclusive — matches booking convention)

notestring nullable

Optional admin caption (properties.pet_blockout_note). Returned when set on the property; the frontend renders it only when the stay is actually blocked, per the Phase E 'immediately relevant' guest-display principle.

Changes

No recorded changes to this operation across all 1 revision of this API.