---
title: "Search for Lettings Properties"
method: GET
path: "/lettings/search"
tags: ["Lettings"]
---

# Search for Lettings Properties

`GET /lettings/search`

## Request

- Base URL: `https://street.co.uk/api/property-feed/v1`
- URL: `https://street.co.uk/api/property-feed/v1/lettings/search`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/street/apis/property-feed/docs/lettings/search/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint returns all active lettings properties in your Street account.

By default it will only return 'active' properties i.e. those with a status of `To Let`, `For Sale and To Let` or `Let Agreed`.

It will also return properties for **ALL** branches within your Street account, if you wish to limit to a specific branch you can use the `filter[branch]` query param and pass the `UUID` of the desired branch.

## Query parameters

- `filter[areas]` string
- `filter[bedrooms]` string
- `filter[min_bedrooms]` string
- `filter[branch]` string
- `filter[features]` string
- `filter[include_land]` string
- `filter[max_price]` string
- `filter[min_price]` string
- `filter[postcode]` string
- `filter[status]` string[]
- `filter[tags]` string
- `include` string[]
- `page[number]` number
- `page[size]` number
- `sort` string[]
- `filter[include_archived]` string

## Response `200`

The API endpoint responds with a JSON object containing a list of lettings properties matching the specified criteria. Each property object within the response typically includes information such as property ID, address, description, rental price, number of bedrooms, and other relevant details. The response also includes pagination metadata, such as the total number of properties, the current page number, and the number of properties per page.

- object
  - `data` Property[]
    - `type` string, required
    - `id` string, uuid, required
    - `attributes` object, required
      - `branch_uuid` string, uuid
      - `inline_address` string
      - `public_address` string: Public anonymous address - can be overridden with 'customise address' when editing a property
      - `postcode` string
      - `bedrooms` integer
      - `bathrooms` integer
      - `receptions` integer
      - `floor_area` integer, nullable
      - `plot_area` integer, nullable
      - `land_area` number, nullable
      - `property_type` 'Not Specified' | 'Other' | 'House' | 'Mews House' | 'Cluster House' | 'Ground Floor Flat' | 'Flat' | 'Studio Flat' | 'Ground Floor Maisonette' | 'Maisonette' | 'Bungalow' | 'Dormer Bungalow' | 'Mobile Home' | 'Land (Residential)' | 'Link Detached' | 'Town House' | 'Cottage' | 'Chalet' | 'Chalet Bungalow' | 'Character Property' | 'House Unspecified' | 'Villa' | 'Apartment' | 'Penthouse' | 'Finca' | 'Barn Conversion' | 'Serviced Apartment' | 'Parking' | 'Sheltered Housing' | 'Retirement Property' | 'House Share' | 'Flat Share' | 'Park Home' | 'Garages' | 'Farm House' | 'Equestrian Facility' | 'Duplex' | 'Triplex' | 'Longere' | 'Gite' | 'Barn' | 'Trulli' | 'Mill' | 'Ruins' | 'Restaurant' | 'Cafe' | 'Castle' | 'Village House' | 'Cave House' | 'Cortijo' | 'Farm Land' | 'Plot' | 'Country House' | 'Stone House' | 'Caravan' | 'Lodge' | 'Log Cabin' | 'Manor House' | 'Stately Home' | 'Off Plan' | 'Detached Villa' | 'Bar Nightclub' | 'Shop' | 'Riad' | 'House Boat' | 'Hotel Room' | 'Block Of Apartments' | 'Private Halls' | 'Office' | 'Business Park' | 'Serviced Office' | 'Retail Property (High Street)' | 'Retail Property (Out Of Town)' | 'Convenience Store' | 'Hairdresser Barber Shop' | 'Hotel' | 'Petrol Station' | 'Post Office' | 'Pub' | 'Workshop Retail Space' | 'Distribution Warehouse' | 'Factory' | 'Heavy Industrial' | 'Industrial Park' | 'Light Industrial' | 'Storage' | 'Showroom' | 'Warehouse' | 'Land (Commercial)' | 'Commercial Development' | 'Industrial Development' | 'Residential Development' | 'Commercial Property' | 'Data Centre' | 'Farm' | 'Healthcare Facility' | 'Marine Property' | 'Mixed Use' | 'Research Development Facility' | 'Science Park' | 'Guest House' | 'Hospitality' | 'Leisure Facility' | 'Takeaway' | 'Childcare Facility' | 'Smallholding' | 'Place Of Worship' | 'Trade Counter' | 'Coach House' | 'House Of Multiple Occupation' | 'Sports Facilities' | 'Spa' | 'Campsite Holiday Village' | 'Chateau' | 'Farm Commercial' | 'Land' | 'Office (Commercial)' | 'Industrial (Commercial)' | 'Retail (Commercial)' | 'Farm (Commercial)' | 'Farm Residential' | 'Other (Commercial)': The property type
      - `property_style` 'null' | 'None' | 'Detached' | 'Semi Detached' | 'Terraced' | 'Mid-Terraced' | 'End of Terrace' | 'Link Detached', nullable: The property style
      - `is_commercial` boolean
      - `property_age_bracket` 'null' | 'Unspecified' | 'New Build' | '2020s' | '2010s' | '2000s' | '1990s' | '1970 - 1990' | '1960 - 1970' | '1940 - 1960' | '1910 - 1940' | 'Edwardian (1901 - 1910)' | 'Victorian (1830 - 1901)' | 'Georgian (1710 - 1830)' | 'Pre-Georgian (pre 1710)', nullable
      - `construction_year` integer, nullable
      - `status` 'Not On The Market' | 'Valuation Lost' | 'Valuation Booked' | 'Valuation Pending' | 'Valuation Cancelled' | 'Provisional Valuation Booked' | 'Valuation Completed' | 'Instructed' | 'For Sale' | 'Under Offer' | 'Sold STC' | 'Exchanged' | 'Let' | 'To Let' | 'Let Agreed' | 'For Sale and To Let' | 'Withdrawn Sales' | 'Withdrawn Lettings' | 'Withdrawn Sales And Lettings' | 'Completed'
      - `sale_status` 'null' | 'Not On The Market' | 'Valuation Lost' | 'Valuation Booked' | 'Valuation Pending' | 'Valuation Cancelled' | 'Provisional Valuation Booked' | 'Valuation Completed' | 'Instructed' | 'For Sale' | 'Under Offer' | 'Sold STC' | 'Exchanged' | 'For Sale and To Let' | 'Withdrawn Sales' | 'Withdrawn Sales And Lettings' | 'Completed', nullable
      - `lettings_status` 'null' | 'Not On The Market' | 'Valuation Lost' | 'Valuation Booked' | 'Valuation Pending' | 'Valuation Cancelled' | 'Provisional Valuation Booked' | 'Valuation Completed' | 'Instructed' | 'Under Offer' | 'Let' | 'To Let' | 'Let Agreed' | 'For Sale and To Let' | 'Withdrawn Lettings' | 'Withdrawn Sales And Lettings', nullable
      - `dual_listing` boolean: This flag denotes wether a Property is both For Sale AND To Let
      - `owner_label` 'Landlord' | 'Vendor' | 'Owner': The label for the owner. Vendor for Sales Properties, Landlord for lettings listings
      - `tenure` 'Leasehold' | 'Freehold' | 'Commonhold' | 'Share of Freehold' | 'Flying Freehold' | 'Share Transfer', nullable
      - `tenure_notes` string, nullable: Specific notes relating to the tenure of the property.
      - `lease_expiry_year` string, nullable
      - `lease_expiry_date` string, nullable
      - `public_url` string
      - `viewing_booking_url` string, nullable
      - `last_instructed_sales_at` string, nullable
      - `last_instructed_lettings_at` string, nullable
      - `last_exchanged_at` string, nullable
      - `last_completed_at` string, nullable
      - `created_at` string
      - `updated_at` string
      - `custom_meta_data` object[]: If the user has entered any custom meta data against this property in the Street UI, the key value pairs will be contained in this object.
        - `meta_name` string
      - `property_urls` PropertyUrl[]
        - `media_type` 'audio_tour' | 'brochure' | 'epc' | 'epc_graph' | 'floor_plan' | 'image' | 'ipack' | 'virtual_tour'
        - `media_url` string
    - `relationships` object, required
      - `address` ToOneRelationship: A one to one relationship to another model, conforming to the JSON:API specification.
        - `data` object, nullable
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `details` ToOneRelationship: A one to one relationship to another model, conforming to the JSON:API specification.
        - `data` object, nullable
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `features` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
        - `data` object[]
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `rooms` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
        - `data` object[]
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `outsideSpaces` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
        - `data` object[]
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `parkingSpaces` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
        - `data` object[]
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `development` ToOneRelationship: A one to one relationship to another model, conforming to the JSON:API specification.
        - `data` object, nullable
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `salesListing` ToOneRelationship: A one to one relationship to another model, conforming to the JSON:API specification.
        - `data` object, nullable
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `lettingsListing` ToOneRelationship: A one to one relationship to another model, conforming to the JSON:API specification.
        - `data` object, nullable
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `primaryImage` ToOneRelationship: A one to one relationship to another model, conforming to the JSON:API specification.
        - `data` object, nullable
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `images` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
        - `data` object[]
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `floorplans` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
        - `data` object[]
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `brochure` ToOneRelationship: A one to one relationship to another model, conforming to the JSON:API specification.
        - `data` object, nullable
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `additionalMedia` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
        - `data` object[]
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `epc` ToOneRelationship: A one to one relationship to another model, conforming to the JSON:API specification.
        - `data` object, nullable
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
      - `tags` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
        - `data` object[]
          - `id` string, uuid, required: The UUID of the entity.
          - `type` string, required: The type/model the entity represents.
        - `links` Links: Links object - JSON:API Standard.
          - `self` string
          - `first` string
          - `next` string
          - `prev` string
          - `last` string
  - `included` union[]
    - union
      - Branch: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `name` string
          - `public_name` string
          - `email_address` string, email
          - `telephone` string
          - `website` string, uri
          - `about_branch_copy` string
          - `disclaimer` string, nullable
          - `address` Address: A single Property entity and related relationships.
            - `type` string, required
            - `id` string, uuid, required
            - `attributes` object, required
              - …
      - Address: A single Property entity and related relationships.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `anon_address` string
          - `line_1` string
          - `line_2` string
          - `line_3` string
          - `line_4` string, nullable
          - `line_5` string, nullable
          - `town` string
          - `country` string
          - `postcode` string
          - `inline` string
          - `longitude` number, nullable
          - `latitude` number, nullable
          - `royal_mail` object, nullable
            - `postcode` string
            - `post_town` string
            - `thoroughfare` string
            - `building_name` string, nullable
            - `building_number` string, nullable
            - `department_name` string, nullable
            - `organisation_name` string, nullable
            - `sub_building_name` string, nullable
            - `dependent_locality` string, nullable
            - `dependent_thoroughfare` string, nullable
            - `double_dependent_locality` string, nullable
      - Details: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `display_property_style` 'None' | 'Other' | 'Mid-Terraced' | 'End of Terrace' | 'Town House' | 'Mews' | 'Barn Conversion' | 'Cottage' | 'Farm House' | 'Maisonette' | 'Studio' | 'Bungalow' | 'Chalet Bungalow' | 'Link Detached' | 'Ground Floor Flat' | 'Castle' | 'Park Home' | 'Hotel' | 'Guest House' | 'Dormer' | 'Equestrian' | 'Penthouse', nullable
          - `work_required` boolean, nullable
          - `heating_system` 'Electric Boiler' | 'Gas Boiler' | 'Storage Heaters' | 'Oil' | 'Gas Tank' | 'Air Source' | 'Electric Heating' | 'Other', nullable
          - `council_tax_band` string, nullable
          - `council_tax_cost` integer, nullable
          - `local_authority` string, nullable
          - `service_charge` integer, nullable
          - `service_charge_period` 'Month' | 'Year', nullable
          - `service_charge_notes` string, nullable
          - `ground_rent` integer, nullable
          - `ground_rent_period` 'Month' | 'Year', nullable
          - `ground_rent_review_period_years` integer, nullable
          - `ground_rent_uplift` integer, nullable: Value is a percentage
          - `ground_rent_expiry` string, nullable
          - `full_description` string, nullable
          - `full_description_lettings` string, nullable
          - `short_description` string, nullable
          - `short_description_lettings` string, nullable
          - `location_summary` string, nullable
          - `agency_registration_number` string, nullable: The agency's registration number (e.g. the Scottish/Welsh letting agent registration number), configured per network.
          - `has_parking` boolean, nullable
          - `has_outdoor_space` boolean, nullable
          - `virtual_tour` string, nullable
          - `shared_ownership` boolean
          - `shared_ownership_notes` string, nullable
          - `shared_ownership_rent` integer, nullable
          - `shared_ownership_rent_frequency` 'Month' | 'Year', nullable
          - `shared_ownership_percentage_sold` integer, nullable
          - `material_information` object
            - `council_tax_band` string, nullable
            - `lease_expiry_date` string, date, nullable
            - `ground_rent_pence` integer, nullable
            - `ground_rent_period` string, nullable
            - `ground_rent_expiry` string, date, nullable
            - `ground_rent_review_period_years` integer, nullable
            - `ground_rent_uplift` integer, nullable: Value is a percentage
            - `service_charge_pence` integer, nullable
            - `service_charge_period` string, nullable
            - `service_charge_notes` string, nullable
            - `water_supply` string[], nullable
            - `water_supply_other` string, nullable
            - `electricity_supply` string[], nullable
            - `electricity_supply_other` string, nullable
            - `sewerage` string[], nullable
            - `sewerage_other` string, nullable
            - `heating_supply` string[], nullable
            - `heating_supply_other` string, nullable
            - `heating_system` 'Electric Boiler' | 'Gas Boiler' | 'Storage Heaters' | 'Oil' | 'Gas Tank' | 'Air Source' | 'Electric Heating' | 'Other', nullable
            - `broadband` string, nullable
            - `has_restrictions` boolean, nullable
            - `has_required_access` boolean, nullable
            - `public_right_of_way` boolean, nullable
            - `sources_of_flooding` unknown[], nullable
              - …
            - `sources_of_flooding_other` string, nullable
            - `has_flood_defences` boolean, nullable
            - `has_flooded_in_last_five_years` boolean, nullable
            - `adaptations_list` unknown[], nullable
              - …
            - `adaptations_other` string, nullable
          - `created_at` string
          - `updated_at` string
      - SalesListing: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `status` 'For Sale' | 'Sold STC' | 'Withdrawn' | 'Under Offer'
          - `price` integer
          - `price_qualifier` 'None' | 'In Excess of' | 'Prices From' | 'Guide Price' | 'Offers Over' | 'Offers in Region of' | 'Fixed Price' | 'Price On Application' | 'Part Buy, Part Rent', nullable
          - `display_price` boolean
          - `archived` boolean
          - `is_low_profile` boolean
          - `is_auction` boolean
          - `publish_after` string, date-time
          - `new_home` boolean
          - `retirement` boolean
          - `occupancy_status` 1 | 2 | 3
          - `created_at` string
          - `updated_at` string
      - LettingsListing: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `status` 'To Let' | 'Let Agreed' | 'Let' | 'Withdrawn'
          - `price_pcm` integer, nullable
          - `deposit` integer, nullable
          - `display_price` boolean
          - `archived` boolean
          - `furnished` 'Unfurnished' | 'Fully Furnished' | 'Part Furnished'
          - `allows_pets` boolean, nullable
          - `is_low_profile` boolean
          - `publish_after` string, date-time
          - `new_home` boolean
          - `retirement` boolean
          - `student_rental` boolean
          - `min_tenancy_period` number, nullable
          - `available_from` string, nullable
          - `created_at` string
          - `updated_at` string
      - Room: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `room_type` 'bedroom' | 'bathroom' | 'kitchen' | 'dining room' | 'lounge' | 'garage' | 'utility room' | 'wc' | 'en-suite' | 'reception' | 'landing' | 'lounge / diner' | 'conservatory' | 'hallway' | 'basement' | 'dressing room' | 'office' | 'attic / loft space' | 'other'
          - `name` string
          - `width` integer, nullable
          - `length` integer, nullable
          - `formatted_dimensions` string, nullable
          - `description` string, nullable
          - `order` string
          - `created_at` string
          - `updated_at` string
        - `relationships` object
          - `media` ToManyRelationship: A one to many relationship to another model, conforming to the JSON:API specification.
            - `data` object[]
              - …
            - `links` Links: Links object - JSON:API Standard.
              - …
      - Media: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `name` string
          - `order` integer
          - `is_featured` boolean
          - `feature_index` integer, nullable
          - `title` string, nullable
          - `media_type` string, nullable: A user defined type to enable categorizing generic media items
          - `is_image` boolean
          - `url` string
          - `urls` object
            - `thumbnail` string
            - `small` string
            - `medium` string
            - `large` string
            - `hero` string
            - `full` string
      - Floorplan: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `name` string
          - `order` integer
          - `is_featured` boolean
          - `feature_index` integer, nullable
          - `title` string, nullable
          - `media_type` string, nullable: A user defined type to enable categorizing generic media items
          - `is_image` boolean
          - `url` string
          - `urls` object
            - `thumbnail` string
            - `small` string
            - `medium` string
            - `large` string
            - `hero` string
            - `full` string
      - Feature: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `name` string
      - OutsideSpace: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `type` 'Garden' | 'Front Garden' | 'Rear Garden' | 'Communal Garden' | 'Yard' | 'Roof Terrace' | 'Balcony': Deprecated: Use `space_type` instead. This field will be removed in a future version.
          - `space_type` 'Garden' | 'Front Garden' | 'Rear Garden' | 'Communal Garden' | 'Yard' | 'Roof Terrace' | 'Balcony'
          - `description` string
          - `width` integer, nullable
          - `length` integer, nullable
          - `area` integer, nullable
          - `orientation` 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW', nullable
          - `created_at` string
          - `updated_at` string
      - ParkingSpace: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `parking_space_type` 'Garage' | 'Car Port' | 'Off Road' | 'On Road' | 'Permit' | 'Secure Gated' | 'Allocated Parking' | 'On Drive'
          - `capacity` integer, nullable
          - `description` string
          - `created_at` string
          - `updated_at` string
      - Epc: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `rating` string
          - `report_url` string, nullable
          - `energy_efficiency_current` string
          - `energy_efficiency_potential` string
          - `environment_impact_current` string
          - `environment_impact_potential` string
          - `created_at` string
          - `updated_at` string
      - AdditionalMedia: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `name` string
          - `order` integer
          - `is_featured` boolean
          - `feature_index` integer, nullable
          - `title` string, nullable
          - `media_type` string, nullable: A user defined type to enable categorizing generic media items
          - `is_image` boolean
          - `url` string
          - `urls` object
            - `thumbnail` string
            - `small` string
            - `medium` string
            - `large` string
            - `hero` string
            - `full` string
      - Tag: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `tag` string
      - Brochure: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `name` string
          - `order` integer
          - `is_featured` boolean
          - `feature_index` integer, nullable
          - `title` string, nullable
          - `is_image` boolean
          - `url` string
      - Development: An inheritable schema used for documentation.
        - `type` string, required
        - `id` string, uuid, required
        - `attributes` object, required
          - `name` string
          - `description` string
          - `created_at` string
          - `updated_at` string
  - `meta` Pagination: Pagination object - JSON:API Standard.
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
  - `links` Links: Links object - JSON:API Standard.
    - `self` string
    - `first` string
    - `next` string
    - `prev` string
    - `last` string

## Other responses

- `400`: The HTTP 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.
- `401`: The HTTP 401 Unauthorized response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.
- `403`: The HTTP 403 Forbidden response status code indicates that the server understands the request but refuses to authorize it.
- `406`: The HTTP 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.
- `415`: The HTTP 415 Unsupported Media Type client error response code indicates that the server refuses to accept the request because the payload format is in an unsupported format.
- `422`: The HTTP 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.
- `500`: The HTTP 500 Internal Server Error server error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

## Changes

- **2026-09-08** `079a8d7e088e`: 28 warning, 21 info
  - added the new `Instructed` enum value to the `data/items/allOf[subschema #2]/attributes/lettings_status` response property for the response status `200`
  - added the new `Instructed` enum value to the `data/items/allOf[subschema #2]/attributes/sale_status` response property for the response status `200`
  - added the new `Instructed` enum value to the `data/items/allOf[subschema #2]/attributes/status` response property for the response status `200`
  - added the new `Provisional Valuation Booked` enum value to the `data/items/allOf[subschema #2]/attributes/lettings_status` response property for the response status `200`
  - …45 more
- **2026-09-02** `84de2fa11dd7`: 6 breaking, 6 info
  - removed the enum value `-created_at` from the `query` request parameter `sort`
  - removed the enum value `-price` from the `query` request parameter `sort`
  - removed the enum value `created_at` from the `query` request parameter `sort`
  - removed the enum value `price` from the `query` request parameter `sort`
  - …8 more

[Operation history](https://skmtc.dev/street/apis/property-feed/changes/lettings/search/get.md)

---

[API](https://skmtc.dev/street/apis/property-feed.md) - [All operations](https://skmtc.dev/street/apis/property-feed/llms.txt) - [OpenAPI document](https://skmtc.dev/street/apis/property-feed/revisions/079a8d7e088e?raw)
