The Property object

idstringrequired

typestringrequired

Possible values: [properties]

attributes required

portfolio_idstring

subpremisestring

house_numberstring

house_namestring

street_line_1string

street_line_2string

town_or_citystring

regionstring

postcodestring

countrystring

landlord_owns_furnitureboolean

bedrooms_countinteger

bathrooms_countinteger

property_service_typestring

Possible values: [managed, let_only, rent_collection]

Default value: managed

management_organisation_property_identifierstring

management_organisation_idstring

reservation_possibleboolean

gas_supply_confirmed_atdate-time

gas_supplyboolean

viewings_paused_atdate-time

viewing_available_fromdate-time

notice_periodstring

metadataobject

Additional metadata for the property

Example: {"field_1":"value1","field_2":"value2"}

bank_details_requiredboolean

archived_atdate-time

letboolean

Indicates if the property is currently let.

active_listingsboolean

Indicates if the property has active listings.

created_atdate-time

updated_atdate-time

The Property object

{
  "id": "string",
  "type": "properties",
  "attributes": {
    "portfolio_id": "string",
    "subpremise": "string",
    "house_number": "string",
    "house_name": "string",
    "street_line_1": "string",
    "street_line_2": "string",
    "town_or_city": "string",
    "region": "string",
    "postcode": "string",
    "country": "string",
    "landlord_owns_furniture": true,
    "bedrooms_count": 0,
    "bathrooms_count": 0,
    "property_service_type": "managed",
    "management_organisation_property_identifier": "string",
    "management_organisation_id": "string",
    "reservation_possible": true,
    "gas_supply_confirmed_at": "2024-07-29T15:51:28.071Z",
    "gas_supply": true,
    "viewings_paused_at": "2024-07-29T15:51:28.071Z",
    "viewing_available_from": "2024-07-29T15:51:28.071Z",
    "notice_period": "string",
    "metadata": {
      "field_1": "value1",
      "field_2": "value2"
    },
    "bank_details_required": true,
    "archived_at": "2024-07-29T15:51:28.071Z",
    "let": true,
    "active_listings": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
  }
}