Update Log

Open API Updates

All notable changes to the Street Open API will be documented in this file.

2025-12-17

Added

  • Added brand_id to sales-listing and lettings-listing objects to allow to see a listing's associated brand.

2025-12-10

Added

  • Webhooks added for:
    • branch.created
    • branch.deleted

2025-11-27

Added

  • Added timestamp fields to lettingsListing and salesListing includes.

2025-11-26

Added

  • Added include_in_listing field to ParkingSpace include to indicate if the parking space should be included in listing.

2025-11-21

Added

  • Property keys can now be included in both the “Get all properties” and “Get a single property” endpoints.

Updated

  • The /enquiries create endpoint has been updated to accept a custom_source up to 25 characters

2025-11-12

Added

  • The /property-keys & /property-keys/{property-keys_id} endpoints have been added for retrieving property key resources

2025-11-10

Added

  • maintenance and inspection relationship added to /notes endpoint.

2025-11-06

Added

  • tenant_type field added to Tenant attribute schema and Company Tenant attribute schema'
  • Ability to include Company Tenants in /tenancies using the tenants include

2025-11-06

Added

  • original_term_start_date field added to Tenancy attributes schema

2025-11-04

Added

  • deactivated_at field added to User attributes schema

2025-10-28

Added

  • lead_rating field added to Applicant attributes schema
  • filter[lead_rating] parameter added to both /sales-applicants and /lettings-applicants endpoints to filter applicants by their lead rating

2025-10-21

Changed

  • Amended styling of sidebar to make endpoints easier to navigate to.
  • Refactored some relationship definitions to be more accurate.

2025-10-14

Added

  • collection has been added to the media and downloadableMedia responses to help differentiate between media types

2025-10-10

Added

  • Key Features endpoints added for managing property key features:
    • POST /open-api/v1/key-features/{property_id} - Create or update key features for a property
    • DELETE /open-api/v1/key-features/{property_id}/features/{feature_id} - Delete a specific key feature from a property
  • id field added to the features array in Property attributes to support individual feature identification

2025-10-08

Added

  • filter[areas] has been added to the sales-applicants and lettings-applicants index endpoints to allow you to filter by an applicants interested areas

2025-10-07

Added

  • Todo Types endpoints GET /open-api/v1/todo-types and GET /open-api/v1/todo-types\{todo_type_id} added for retrieving todo types (custom task types).

2025-09-29

Added

  • Todos endpoints GET /open-api/v1/todos and POST /open-api/v1/todos added for retrieving and creating todos (tasks).

2025-09-11

Added

  • matching_links_to_website field on the Branch object to see if custom property matching links are enabled for the branch.
  • matching_url_pattern field on the Branch object to see the URL pattern for custom property matching links for the branch.

2025-09-10

Added

  • Portal Listings endpoint GET /open-api/v1/portal-listings/{listing_id} added for retrieving portal listing details
  • property_id field added to Portal Listing attributes to provide direct access to the associated property UUID

2025-08-14

Added

  • ApplicantPreferenceChoice schema updated to include Must Have option
  • new_property_type_preferences object added to ApplicantAttributes
  • depricated flag added to property_type_preferences attribute of ApplicantAttributes

2025-08-14

Added

  • New endpoints for managing individual photos and floorplans:
    • PUT /photos/{property_id}/media/{media_id} - Update a photo for a property
    • DELETE /photos/{property_id}/media/{image_id} - Delete a photo from a property
    • DELETE /floorplans/{property_id}/media/{image_id} - Delete a floorplan from a property

2025-08-11

Added

  • virtual_tour and property_urls fields added to /properties and /properties/{property_id}.
  • /properties/{property_id} patch endpoint now supports updating virtual tour URLs and property URLs

2025-07-18

Added

Webhook added for:

  • questionnaire-response.submitted

2025-07-18

Added

  • Questionnaire Response endpoint GET /open-api/v1/questionnaire-responses/{questionnaire_response_id} added for retrieving complete PIQ data including sections, questions, answers, property and people

2025-07-16

Updated

  • IncludedOwner schema updated to include the company relationship.

2025-07-15

Added

  • Property description fields (full_description, short_description, location_summary, full_description_lettings, short_description_lettings, location_summary_lettings) available in the property object. Property descriptions can be updated via the /properties/{property_id} endpoint

2025-07-14

Added

  • guarantors added to the /tenancies & /tenancies/{tenancy_id} endpoints as an include.

2025-06-30

Added

  • disclaimer added the branch object and includes

2025-06-27

Added

  • rooms.media added to the includes for all /properties

2025-06-25

Added

  • archived_at to PropertyTransformer

2025-06-24

Added

  • Webhooks for the property.archived & property.unarchived events are now available

2025-06-20

Added

  • Added the following endpoints to allow you to POST images using a remote URL into Street
  • /photos/{id}
  • /floorplans/{id}

2025-06-19

Updated

  • The filters filter[max_price] and filter[min_price] have now been deprecated in favour of filter[max_price_sales], filter[max_price_lettings], filter[min_price_sales], filter[min_price_lettings]. To allow for greater control of the data returned.

2025-06-17

Updated

  • sources_of_flooding type changed to an array of strings

2025-06-16

Added

  • flood_risk added to PropertyTransformer

2025-06-13

Added

  • is_listed_building and is_conservation_area property added to PropertyTransformer

2025-05-28

Added

  • include_in_listing property added to DefaultMedia

2025-05-01

Added

The buying position In process of selling - Under Offer (UO) has been added as an option on the buying_position filter on the /sales-applicants endpoint

2025-04-29

Added

The photographer include has been added to the following endpoints; /photo-and-measures, /photo-and-measures/{id}

2025-04-17

Added

The /solicitors & /solicitors/{solicitors_id} endpoints have been added for retrieving solicitor resources Added lettingsApplication include to /tenancies & /tenancies/{tenancy_id} endpoints

2025-04-15

Added

  • A new resource "Esign Document" has been added, with a an endpoint to retrieve an individual esign document at /esign-documents/{esign_document_id}. Webhooks have been added for esign document events.
  • custom_status has been added to the valuation resource
  • is_not_in_property_feed_api has been added to both sales & lettings listing resources
  • New webhooks have been added for when sales & lettings listings are withdrawn

2025-04-03

Added

The company include has been added to the following endpoints; /lettings-applicants, /lettings-applicants/{id}, /sales-applicants, /lettings-applicants/{id}

2025-03-12

Changed

  • Fixed example responses that did not fully reflect the spec.
  • Removed unused schemas.
  • Refactored some type definitions to be more accurate.

2025-14-01

Added

The /brands & /brands/{brand_id} endpoints have been added for retrieving brand resources

2024-12-18

Added

The person relationship has been added to the Enquiry resource

2024-11-27

Added

Webhooks have been added for inspection events

2024-11-18

Added

Webhooks have been added for:

  • listing.sales.created
  • listing.lettings.created
  • listing.sales.updated
  • listing.lettings.updated
  • listing.sales.removed
  • listing.lettings.removed
  • instruction.sales.created
  • instruction.lettings.created
  • instruction.sales.updated
  • instruction.lettings.updated
  • instruction.sales.revoked
  • instruction.lettings.revoked

2024-10-22

Added

  • inline_address & public_address properties added for Properties

2024-10-11

Added

  • interestedApplicants includes added for Properties

2024-08-09

Added

  • Sales Instruction & Lettings Instruction includes added

2024-08-08

Added

  • Viewing cancelled_at timestamp added

2024-08-08

Added

  • Valuation sales report & Valuation lettings report includes added

2024-08-06

Added

  • Valuation cancelled_at timestamp added

2024-07-22

Changed

  • Property tags & features have been updated to a well-defined flat object structure
  • Some properties of tags & features which were mistakenly included have been removed

2024-07-11

Added

  • Property include_archived filter added

2024-06-24

Added

  • Areas endpoint
  • Property area filter added

2024-06-04

Added

  • Adding a Note now available for:
  • lettingsOffer
  • person
  • Property salesOffers, lettingsOffers & lettingsApplications includes
  • Lettings Applicant lettingsApplications include

2024-05-22

Added

  • Property is_commercial & is_residential attributes
  • Single Enquiry endpoint

2024-04-01

Added

  • Address town attribute

2024-04-12

Added

  • Sales Offers endpoint
  • Lettings Offers endpoint

2024-03-20

Added

  • Adding a Note now available for:
  • company
  • person
  • property
  • tenancy
  • salesApplicant
  • lettingsApplicant
  • enquiry
  • sale
  • salesOffer
  • valuation
  • viewing

2024-02-23

Added

  • Filtering People, Landlords, Tenants and Vendors by address

2024-02-16

Changed

  • Owner attributes

Added

  • Owner is_company attribute

2024-02-12

Added

  • is_sales & is_lettings attributes added for Properties
  • Sales Listing include for Sales Offers
  • Lettings Listing include for Lettings Offers
  • Sales/Lettings Listings includes for Properties
  • Valuer & Owner includes added for Valuations
  • Viewer & Owner includes added for Viewings

Deprecated

  • sales attributes for Properties
  • lettings attributes for Properties
  • owner attribute for Properties
  • listings attribute for Properties
  • people attribute for Owners
  • people attribute for Sales/Lettings Applicants
  • vendor attribute for Sales
  • applicant attribute for Sales
  • listing attribute for Sales/Lettings Offers
  • owner attribute for Valuations
  • valuer attribute for Valuations
  • owner attribute for Viewings
  • applicant attribute for Viewings
  • viewer attribute for Viewings

2024-02-07

Added

  • Follow Ups endpoint

2024-01-30

Added

  • Statuses added to People responses

2024-01-24

Added

  • Sales added to Applicant includes

2023-10-18

Added

  • Negotiator includes for Properties and Vendors
  • Filtering Properties by sales/lettings

2023-09-29

Added

  • Tenancies endpoint

2023-08-04

Added

  • New filtering options:
    • Filter Sales Applicants by Buying Position
    • Filter Valuations by Branch
    • Filter Valuations by Status
    • Filter Landlords by Status (current/previous)
    • Filter Tenants by Status (current/previous)
    • Filter Vendors by Status (current/previous)
    • Filter Vendors by Property Status

2023-07-15

Added

  • Notes endpoint

2023-07-15

Added

  • Additional relationships for Properties

2023-07-18

Added

  • Relationship links

2023-07-07

Changed

  • Versioning introduced

2023-06-28

Added

  • Url parameters changed to snake_case

2023-05-23

Added

  • Sales endpoints

2023-05-18

Added

  • Automatic updates posted to Slack

2023-05-17

Changed

  • Tenants includes modified to allow nested properties to be returned

2023-05-16

Changed

  • Open API documentation made available to the public
Previous
FAQs