Properties

Retrieve a Property

Changed on

This endpoint retrieves a single property by its UUID.

get/properties/{property}

Request

Query parameters

includestring[]

Optional related entities to include in the results.

Response

The API endpoint responds with a JSON object containing detailed information about the property identified by the provided UUID. The response includes various attributes related to the property, such as its ID, address, description, price, number of bedrooms, and other relevant details.

Example response

{
  "data": {
    "type": "property",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "attributes": {
      "branch_uuid": "b8e564e2-b92d-49d7-8331-85bb2766d8f8",
      "inline_address": "Rivendell, Main Street",
      "public_address": "Main Street, Follifoot, HG3",
      "postcode": "HG3 1DU",
      "bedrooms": 3,
      "bathrooms": 1,
      "receptions": 2,
      "floor_area": null,
      "plot_area": null,
      "land_area": null,
      "property_type": "Terraced House",
      "property_style": "None",
      "is_commercial": false,
      "property_age_bracket": "1970 - 1990",
      "construction_year": null,
      "status": "Sold STC",
      "sale_status": "Sold STC",
      "lettings_status": "For Sale and To Let",
      "dual_listing": false,
      "owner_label": "Owner",
      "tenure": "Freehold",
      "tenure_notes": null,
      "lease_expiry_year": "2022",
      "lease_expiry_date": null,
      "public_url": "https://street.co.uk/platform/properties/0ed2e2f4-b697-4c78-a801-d805b75a75aa",
      "viewing_booking_url": null,
      "created_at": "2022-02-28T11:46:20+00:00",
      "updated_at": "2022-06-20T13:30:25+01:00",
      "custom_meta_data": [
        {
          "meta_name": "meta value"
        }
      ],
      "property_urls": [
        {
          "media_type": "audio_tour",
          "media_url": "string"
        }
      ]
    },
    "relationships": {
      "address": {
        "data": {
          "type": "address",
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "details": {
        "data": {
          "type": "details",
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "salesListing": {
        "data": {
          "type": "sales_listing",
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "lettingsListing": {
        "data": {
          "type": "lettings_listing",
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "primaryImage": {
        "data": {
          "type": "primary_image",
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "rooms": {
        "data": [
          {
            "type": "room",
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "images": {
        "data": [
          {
            "type": "media",
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "floorplans": {
        "data": [
          {
            "type": "floorplan",
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "features": {
        "data": [
          {
            "type": "feature",
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "outsideSpaces": {
        "data": [
          {
            "type": "outsideSpace",
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "parkingSpaces": {
        "data": [
          {
            "type": "parkingSpace",
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "epc": {
        "data": {
          "type": "epc",
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "additionalMedia": {
        "data": [
          {
            "type": "media",
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "tags": {
        "data": [
          {
            "type": "tag",
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        ]
      },
      "brochure": {
        "data": {
          "type": "brochure",
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "development": {
        "data": {
          "type": "development",
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      }
    }
  },
  "included": [
    {
      "type": "branch",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "attributes": {
        "name": "Worsley",
        "public_name": "Briscombe",
        "email_address": "user@example.com",
        "telephone": "string",
        "website": "http://example.com",
        "about_branch_copy": "string"
      }
    }
  ]
}

Changes

    • warning

      added the new Instructed enum value to the /// response property for the response status

    • warning

      added the new Instructed enum value to the /// response property for the response status

    • warning

      added the new Instructed enum value to the /// response property for the response status

    • warning

      added the new Provisional Valuation Booked enum value to the /// response property for the response status

    • warning

      added the new Provisional Valuation Booked enum value to the /// response property for the response status

    • warning

      added the new Provisional Valuation Booked enum value to the /// response property for the response status

    • warning

      added the new Valuation Booked enum value to the /// response property for the response status

    • warning

      added the new Valuation Booked enum value to the /// response property for the response status

    • warning

      added the new Valuation Booked enum value to the /// response property for the response status

    • warning

      added the new Valuation Cancelled enum value to the /// response property for the response status

    • warning

      added the new Valuation Cancelled enum value to the /// response property for the response status

    • warning

      added the new Valuation Cancelled enum value to the /// response property for the response status

    • warning

      added the new Valuation Completed enum value to the /// response property for the response status

    • warning

      added the new Valuation Completed enum value to the /// response property for the response status

    • warning

      added the new Valuation Completed enum value to the /// response property for the response status

    • warning

      added the new Valuation Lost enum value to the /// response property for the response status

    • warning

      added the new Valuation Lost enum value to the /// response property for the response status

    • warning

      added the new Valuation Lost enum value to the /// response property for the response status

    • warning

      added the new Valuation Pending enum value to the /// response property for the response status

    • warning

      added the new Valuation Pending enum value to the /// response property for the response status

    • warning

      added the new Valuation Pending enum value to the /// response property for the response status

    • warning

      added the new Withdrawn Lettings enum value to the /// response property for the response status

    • warning

      added the new Withdrawn Lettings enum value to the /// response property for the response status

    • warning

      added the new Withdrawn Sales enum value to the /// response property for the response status

    • warning

      added the new Withdrawn Sales enum value to the /// response property for the response status

    • warning

      added the new Withdrawn Sales And Lettings enum value to the /// response property for the response status

    • warning

      added the new Withdrawn Sales And Lettings enum value to the /// response property for the response status

    • warning

      added the new Withdrawn Sales And Lettings enum value to the /// response property for the response status

    • info

      for the query request parameter include, the maxItems was increased from 12 to 15

    • info

      added the enum value epc.image to the property items/ of the query request parameter include

    • info

      added the optional property //// to the response with the status

    • breaking

      the response's property type changed from array to no type for status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #2 to the response property allOf list for the response status