> For the complete documentation index, see [llms.txt](https://developer.siteminder.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.siteminder.com/direct-booking-api/reference/property.md).

# Property

Return detailed information for a specific property contained in your group.

{% hint style="info" %}
**API:** Direct Booking · **Operation:** Property · **Direction:** SM → Property · **Method:** Pull (Property-initiated)
{% endhint %}

## Retrieve property details

> Retrieve detailed information for a property.<br>

```json
{"openapi":"3.1.0","info":{"title":"Direct Booking API","version":"0.0.1"},"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"x-sm-api-key","in":"header"}},"schemas":{"Property":{"type":"object","additionalProperties":false,"required":["uuid","name","latitude","longitude","timezone","currencyIsoCode","bookingEngineUrl","address","description","termsAndConditions","instructionsToLocation","features","policies","photos","cancellationPenalties"],"properties":{"uuid":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[a-zA-Z0-9]+$","minLength":10}],"description":"Unique identifier for the property in the SiteMinder Direct Booking product."},"name":{"type":"string","description":"The property name as it appears in the SiteMinder Direct Booking product."},"latitude":{"type":"number","description":"Geographic latitude of the property."},"longitude":{"type":"number","description":"Geographic longitude of the property."},"timezone":{"type":"string","description":"IANA time zone identifier for the property (e.g. Australia/Sydney)."},"currencyIsoCode":{"type":"string","description":"ISO 4217 three-letter currency code used for pricing at this property."},"bookingEngineUrl":{"type":"string","nullable":true,"format":"uri","description":"URL to the property's booking engine."},"description":{"type":"string","nullable":true,"description":"The property description as it appears in the SiteMinder Direct Booking product."},"termsAndConditions":{"type":"string","nullable":true,"description":"The property's terms and conditions"},"instructionsToLocation":{"type":"string","nullable":true,"description":"Directions or instructions for reaching the property."},"address":{"type":"object","additionalProperties":false,"description":"The property's full address.","required":["addressLine1","addressLine2","suburb","state","postcode","country"],"properties":{"addressLine1":{"type":"string","description":"Primary street address"},"addressLine2":{"type":"string","nullable":true,"description":"Secondary address information (e.g. suite, apartment, floor)"},"suburb":{"type":"string","description":"Suburb or locality"},"state":{"type":"string","description":"State or province"},"postcode":{"type":"string","description":"Postal or zip code"},"country":{"type":"string","nullable":true,"description":"Country where the property is located"}}},"features":{"type":"object","additionalProperties":false,"description":"property amenities grouped by category, each an empty array when the property has no amenities in that category","required":["facilities","parking","transport"],"properties":{"facilities":{"type":"array","items":{"$ref":"#/components/schemas/Property/properties/features/properties/parking/items"}},"parking":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["otaCode","name"],"properties":{"otaCode":{"type":"integer","format":"int32","description":"OTA amenity code"},"name":{"type":"string","description":"English name of the amenity"}}}},"transport":{"type":"array","items":{"$ref":"#/components/schemas/Property/properties/features/properties/parking/items"}}}},"policies":{"type":"object","additionalProperties":false,"description":"Property policies. Always present; individual policies are always present with null fields when unset.","required":["smokingPolicy","checkInCheckOut"],"properties":{"smokingPolicy":{"type":"object","additionalProperties":false,"description":"smoking policy derived from property amenities. Every field is true or null, never false. All three are null when none of OTA codes 312, 198 and 268 are present. When OTA code 312 is present, nonSmokingRooms and allPublicAreasNonSmoking are always null.\n","required":["smokeFreeProperty","nonSmokingRooms","allPublicAreasNonSmoking"],"properties":{"smokeFreeProperty":{"type":"boolean","nullable":true,"description":"property is smoke-free (OTA code 312)"},"nonSmokingRooms":{"type":"boolean","nullable":true,"description":"property offers non-smoking rooms (OTA code 198)"},"allPublicAreasNonSmoking":{"type":"boolean","nullable":true,"description":"all public areas of the property are non-smoking (OTA code 268)"}}},"checkInCheckOut":{"type":"object","additionalProperties":false,"description":"Check-in and check-out time windows. Always present; individual time fields are null when unset.","required":["checkInStartTime","checkInEndTime","checkOutStartTime","checkOutEndTime","restrictedCheckInCheckOut"],"properties":{"checkInStartTime":{"type":"string","nullable":true,"description":"Earliest check-in time, format HH:MM"},"checkInEndTime":{"type":"string","nullable":true,"description":"Latest check-in time, format HH:MM"},"checkOutStartTime":{"type":"string","nullable":true,"description":"Earliest check-out time, format HH:MM"},"checkOutEndTime":{"type":"string","nullable":true,"description":"Latest check-out time, format HH:MM"},"restrictedCheckInCheckOut":{"type":"boolean","description":"True when the property enforces both a latest check-in time and an earliest check-out time"}}}}},"photos":{"type":"array","description":"Property-level photos, ordered by their stored position ascending with unpositioned photos last. Empty array when the property has no photos.\n","items":{"type":"object","additionalProperties":false,"required":["url","caption","sortOrder"],"properties":{"url":{"type":"string","format":"uri","description":"Public URL of the photo"},"caption":{"type":"string","nullable":true,"description":"Caption for the photo, null when none is set"},"sortOrder":{"type":"integer","format":"int32","nullable":true,"description":"Display order, starting at 1 and contiguous across photos that have a stored position. Null for photos with no stored position; these always come last.\n"}}}},"cancellationPenalties":{"type":"array","description":"The property's cancellation penalty policies. A seasonal policy applies when its date range covers the check-in date, and takes precedence over the default policy (the one with no date range). Room rate policies take precedence over both. Empty array when none are configured.\n","items":{"type":"object","additionalProperties":false,"required":["isDefault","startDate","endDate","penaltyRules"],"properties":{"isDefault":{"type":"boolean","description":"True for the property's default policy - the only one with no date range."},"startDate":{"type":"string","format":"date","nullable":true,"description":"Start of the date range this policy applies to (inclusive). Null for the default policy."},"endDate":{"type":"string","format":"date","nullable":true,"description":"End of the date range this policy applies to (inclusive). Null for the default policy."},"penaltyRules":{"type":"array","description":"Tiered penalty rules for this policy, ordered by daysPriorCheckIn descending.","items":{"type":"object","additionalProperties":false,"required":["daysPriorCheckIn","penaltyType","amount"],"properties":{"daysPriorCheckIn":{"type":"integer","format":"int32","nullable":true,"description":"Number of days before check-in this rule takes effect. Null is treated as 0."},"penaltyType":{"type":"string","enum":["no-penalty","full-amount","percentage","first-night","fixed-amount"],"description":"The kind of penalty charged."},"amount":{"type":"number","nullable":true,"description":"Penalty amount: a percentage (0-100) when penaltyType is 'percentage', or an amount in the property's currency when it is 'fixed-amount'. Not meaningful for other penalty types.\n"}}}}}}}}}},"responses":{"NotAuthorised":{"description":"Not Authorised","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}},"NotFound":{"description":"The specified resource was not found","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"type":"string","description":"Character string with length 1 to 36 and with uuid format","minLength":1,"maxLength":36,"format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["message","name"],"properties":{"message":{"type":"string"},"name":{"type":"string"},"meta":{"type":"object","description":"Error metadata"}}}}}}}}},"AccessDenied":{"description":"Access Denied","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}},"RateLimited":{"description":"Rate Limited","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}},"InternalServerError":{"description":"Internal Server Error","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}}},"parameters":{"apiKey":{"name":"x-sm-api-key","in":"header","schema":{"type":"string"},"required":true,"description":"API key used to authenticate the request."},"propertyUuid":{"in":"path","name":"propertyUuid","required":true,"schema":{"type":"string"},"description":"UUID for a property."}}},"paths":{"/properties/{propertyUuid}":{"get":{"tags":["property:read"],"operationId":"getProperty","summary":"Retrieve property details","description":"Retrieve detailed information for a property.\n","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"401":{"$ref":"#/components/responses/NotAuthorised"},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"}},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/propertyUuid"}]}}}}
```

{% hint style="success" icon="sparkles" %}

## Still have questions?

Use the <i class="fa-gitbook-assistant">:gitbook-assistant:</i> **Ask** button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.

If you need more support, visit [Integration Support](/integration-support/integration-support.md).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.siteminder.com/direct-booking-api/reference/property.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
