Get Property Details

Get Property Details API

Retrieve detailed information about a specific property by its ID.

Endpoint

GET /properties/:id

Authentication

Required. All API requests must be authenticated using your API key. See the Authentication section in the API Overview documentation.

Path Parameters

Parameter Type Required Description id string (UUID) Yes The unique identifier of the property

Query Parameters

Parameter Type Description Default filterByOrganization boolean Only return if property belongs to your organization false includeBranding boolean Include organization branding information false includeAdCount boolean Include count of active ads for the property false includeAdCreatives boolean Include ad creative details (max 3 most recent) false

Response

Success Response (200 OK)

Returns a single property object with all details:

Error Responses

404 Not Found

When using filterByOrganization=true:

401 Unauthorized

400 Bad Request

Example Requests

Basic Request

With All Optional Data

Check Property Ownership

Code Examples

JavaScript/TypeScript

Python

PHP

Use Cases

1. Property Detail Page

Display comprehensive property information on a dedicated page:

2. Property Verification

Check if a property belongs to your organization:

3. Property Comparison

Fetch multiple properties for side-by-side comparison:

Tips and Best Practices

1. Error Handling: Always handle 404 errors gracefully - properties may be deleted or become inactive

2. Optional Data: Only request includeBranding and includeAdCreatives when you need them to minimize response size

3. Caching: Consider caching property details on your frontend to reduce API calls

4. Deep Linking: Property IDs can be used in URLs for direct deep linking to property pages

5. Organization Filtering: Use filterByOrganization=true when you need to verify ownership before allowing edits

6. Image Display:

   • Use images array for full-size images in galleries

   • Use thumbnails array for preview/listing views

   • The isFeatured flag indicates the hero image

7. Agent Information: Agent data is automatically included when available and either includeAdCount or includeAdCreatives is true