---
title: "Retrieve a property"
method: GET
path: "/properties/{property_id}"
tags: ["Properties"]
---

# Retrieve a property

`GET /properties/{property_id}`

## Request

- Base URL: `https://api.easybroker.com/v1/integration_partners`
- URL: `https://api.easybroker.com/v1/integration_partners/properties/{property_id}`
- Auth: API key in header `X-Authorization`

Returns the detailed information of a property linked to your integration

## Response `200`

Successful property request.

- Property
  - `public_id` string
  - `title` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `url` string
  - `description` string: The property listing description.
  - `property_type` string
  - `bedrooms` integer, nullable
  - `bathrooms` integer, nullable
  - `half_bathrooms` integer, nullable
  - `parking_spaces` integer, nullable
  - `lot_size` number, nullable: In square meters
  - `construction_size` number, nullable: In square meters
  - `rental_maintenance_included` boolean, nullable: Indicates whether monthly maintenance is included in the rental price. Required when rental is active and maintenance_amount is provided; otherwise it is `null` when rental is inactive.
  - `maintenance_amount` integer, nullable: Monthly maintenance amount. When rental is active, rental_maintenance_included must be specified; the amount is required when that field is `false`.
  - `maintenance_currency` string: Currency of the maintenance amount. Defaults to the operation currency (rental, sale or temporary rental, in that order) when no maintenance currency has been set.
  - `lot_length` number, nullable
  - `lot_width` number, nullable
  - `floors` integer, nullable: The number of floors in the building.
  - `floor` string, nullable: The floor number in which the property is located, useful for apartments. It can be set to a custom value such as 'Penthouse'
  - `age` string, nullable: One of "under_construction", "new_construction" or the year the building was built.
  - `agency_id` string
  - `agent_id` string, nullable
  - `ad_type` string, nullable
  - `location` PropertyLocation
    - `region` string
    - `city` string
    - `city_area` string, nullable
    - `street` string, nullable
    - `postal_code` string, nullable
    - `latitude` number, nullable
    - `longitude` number, nullable
    - `show_exact_location` boolean
  - `operations` PropertyOperation[]
    - union
      - PropertyOperationSaleOrRental
        - `type` 'sale' | 'rental', required
        - `amount` number, double, nullable
        - `formatted_amount` string
        - `currency` string, required
        - `unit` 'total' | 'square_meter' | 'hectare', required: Some properties, like warehouses, are sold and rented per square meter. Some terrains are rented per hectare.
      - PropertyOperationTemporaryRental
        - `type` string, required
        - `amount` number, double, nullable
        - `formatted_amount` string
        - `currency` string, required
        - `period` 'monthly' | 'weekly' | 'daily': The API returns one temporary rental rate, choosing monthly, weekly, then daily when several rates are stored.
  - `foreclosure` boolean: Indicates whether the property is up for auction. This option is available only to agencies in Mexico.
  - `adjudicated` boolean: Indicates whether the property has been legally awarded to a creditor. This option is available only to agencies in Mexico.
  - `features` PropertyFeature[]
    - `id` integer
    - `name` string
    - `name_es` string
    - `name_pt` string
    - `country_id` integer
  - `tags` string[]: Tags added by users as private information to classify properties, EasyBroker is not responsible for the content entered. Tags should only be use for filtering purposes, not listing display.
  - `images` PropertyImage[]
    - `url` string: The s query parameter is a signature of the image path and the image is not served without it. The version query parameter changes when the image is updated and invalidates cached copies. Store the complete URL returned by the API and refresh it when synchronizing the property.
    - `title` string, nullable
  - `videos` string[]
  - `virtual_tour` string, nullable

## Other responses

- `401`: API key is missing or invalid, or a restricted country was selected
- `404`: The property doesn't exist in EasyBroker or for your integration.

---

[API](https://skmtc.dev/easybroker/apis/app-integration-api.md) - [All operations](https://skmtc.dev/easybroker/apis/app-integration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/easybroker/apis/app-integration-api/revisions/1392dace0720?raw)