---
title: "Get all Lettings Offers"
method: GET
path: "/lettings-offers"
tags: ["Lettings Offers"]
---

# Get all Lettings Offers

`GET /lettings-offers`

## Request

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

This endpoint retrieves multiple paginated lettings offers along with `meta` and `pagination` information.

## Query parameters

- `filter[status]` string[]
- `filter[branch]` string, uuid
- `filter[trashed]` 'with' | 'only'
- `filter[created_from]` string, date-time
- `filter[created_to]` string, date-time
- `filter[updated_from]` string, date-time
- `filter[updated_to]` string, date-time
- `include` string[]
- `page[size]` number
- `page[number]` number

## Response `200`

OK.

- object
  - `data` LettingsOffer[]
    - `id` string, uuid
    - `type` 'lettings_offer'
    - `attributes` object
      - `address` AddressSimple
        - `single_line` string
        - `anon_single_line` string
        - `building_number` string, nullable
        - `building_name` string, nullable
        - `street` string, nullable
        - `line_1` string
        - `line_2` string, nullable
        - `line_3` string, nullable
        - `line_4` string, nullable
        - `town` string, nullable
        - `country` string
        - `postcode` string
        - `udprn` string, nullable
        - `geo` object
          - `lat` number, float, nullable
          - `lng` number, float, 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
        - `street_group_property_id` string, nullable
      - `desired_tenancy_length` integer: Number of months desired
      - `desired_move_in_date` string, date-time
      - `rent_amount` integer
      - `rent_frequency` 'Per Week' | 'Per 2 Weeks' | 'Per 4 Weeks' | 'Per Calendar Month' | 'Per Quarter' | 'Per 6 Months' | 'Per Annum'
      - `tenants_under_18` integer
      - `pets` boolean
      - `smokers` boolean
      - `status` 'Pending' | 'Relayed To Owner' | 'Rejected' | 'Accepted' | 'Withdrawn'
      - `deleted_at` string, date-time, nullable
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `relationships` object
      - `property` object: Inheritable schema for 1:1 relationships. Data may be null if the relationship is empty.
        - `data` object, nullable
          - `type` 'property', required
          - `id` string, uuid, required
        - `links` object
          - `self` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
          - `related` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
      - `branch` object: Inheritable schema for 1:1 relationships. Data may be null if the relationship is empty.
        - `data` object, nullable
          - `type` 'branch', required
          - `id` string, uuid, required
        - `links` object
          - `self` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
          - `related` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
      - `lettingsListing` object: Inheritable schema for 1:1 relationships. Data may be null if the relationship is empty.
        - `data` object, nullable
          - `type` 'lettings_listing', required
          - `id` string, uuid, required
        - `links` object
          - `self` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
          - `related` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
      - `applicant` object: Inheritable schema for 1:1 relationships. Data may be null if the relationship is empty.
        - `data` object, nullable
          - `type` 'applicant', required
          - `id` string, uuid, required
        - `links` object
          - `self` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
          - `related` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
      - `notes` object: This is a inheritable schema to allow you to easily add relationships to your main schemas. This should be used for `1:n` relationships.
        - `data` object[]
          - `type` 'note'
          - `id` string
        - `links` object
          - `self` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
          - `related` union
            - string, uri-reference: a string containing the link's URL
            - object
              - …
  - `included` union[]
    - union
      - IncludedBranch
        - `type` 'branch', required
        - `id` string, uuid, required
        - `attributes` object
          - `address` AddressSimple
            - `single_line` string
            - `anon_single_line` string
            - `building_number` string, nullable
            - `building_name` string, nullable
            - `street` string, nullable
            - `line_1` string
            - `line_2` string, nullable
            - `line_3` string, nullable
            - `line_4` string, nullable
            - `town` string, nullable
            - `country` string
            - `postcode` string
            - `udprn` string, nullable
            - `geo` object
              - …
            - `royal_mail` object, nullable
              - …
            - `street_group_property_id` string, nullable
          - `name` string
          - `public_name` string, nullable
          - `email_address` string, email
          - `telephone` string
          - `website` string, uri, nullable
          - `about_branch_copy` string, nullable
          - `disclaimer` string, nullable
          - `matching_links_to_website` boolean, nullable: If true, custom property matching links are enabled for the branch.
          - `matching_url_pattern` string, nullable: Pattern for property match URLs on the agent website: https://www.yourwebsite.co.uk/property/{UUID}
          - `created_at` string, date-time
          - `updated_at` string, date-time
        - `relationships` object, nullable
        - `meta` Meta: The server's implementation.
      - IncludedProperty
        - `type` 'property', required
        - `id` string, uuid, required
        - `attributes` object
          - `is_sales` boolean
          - `is_lettings` boolean
          - `company_owned` boolean
          - `is_commercial` boolean
          - `is_residential` boolean
          - `address` AddressSimple
            - `single_line` string
            - `anon_single_line` string
            - `building_number` string, nullable
            - `building_name` string, nullable
            - `street` string, nullable
            - `line_1` string
            - `line_2` string, nullable
            - `line_3` string, nullable
            - `line_4` string, nullable
            - `town` string, nullable
            - `country` string
            - `postcode` string
            - `udprn` string, nullable
            - `geo` object
              - …
            - `royal_mail` object, nullable
              - …
            - `street_group_property_id` string, nullable
          - `inline_address` string
          - `public_address` string
          - `status` 'Not On The Market' | 'Valuation Lost' | 'Valuation Booked' | 'Provisional Valuation Booked' | 'Valuation Pending' | 'Valuation Cancelled' | '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'
          - `bedrooms` integer
          - `bathrooms` integer
          - `receptions` integer
          - `floor_area` string, nullable
          - `plot_area` string, nullable
          - `land_area` string, nullable
          - `full_description` string, nullable
          - `short_description` string, nullable
          - `location_summary` string, nullable
          - `full_description_lettings` string, nullable
          - `short_description_lettings` string, nullable
          - `location_summary_lettings` string, nullable
          - `property_type` string
          - `property_style` string
          - `property_age_bracket` string
          - `construction_year` union
            - string
            - integer
          - `is_listed_building` boolean, nullable
          - `is_conservation_area` boolean, nullable
          - `tenure` string
          - `tenure_notes` string, nullable
          - `lease_expiry_year` string, nullable
          - `lease_expiry_date` string, date, nullable
          - `lease_start_date` string, date, nullable
          - `lease_term_years` integer, nullable
          - `display_property_style` string
          - `work_required` boolean
          - `heating_system` string
          - `council_tax_band` string
          - `council_tax_cost` integer, nullable
          - `local_authority` string, nullable
          - `service_charge` integer
          - `service_charge_period` string
          - `service_charge_notes` string, nullable
          - `ground_rent` integer, nullable
          - `ground_rent_period` string
          - `ground_rent_review_period_years` integer, nullable
          - `ground_rent_uplift` integer, nullable
          - `ground_rent_expiry` string, nullable
          - `has_outdoor_space` boolean, nullable
          - `shared_ownership` boolean
          - `shared_ownership_notes` string, nullable
          - `shared_ownership_rent` integer, nullable
          - `shared_ownership_rent_frequency` string, nullable
          - `shared_ownership_percentage_sold` integer, nullable
          - `tags` object[]
            - `name` string
            - `slug` string
            - `order` number
          - `features` object[]
            - `id` string, uuid: The ID of the feature
            - `name` string
            - `order` number
            - `include_on_portals` boolean
            - `highlight` boolean
          - `material_information` object
            - `council_tax_band` string, nullable
            - `lease_expiry_date` string, date, nullable
            - `lease_start_date` string, date, nullable
            - `lease_term_years` integer, 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` string, nullable
            - `broadband` 'adsl' | 'cable' | 'fttc' | 'fttp' | 'null', nullable
            - `has_restrictions` boolean, nullable
            - `has_required_access` boolean, nullable
            - `public_right_of_way` boolean, nullable
            - `flood_risk` boolean, nullable
            - `sources_of_flooding` string[], 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
          - `viewing_booking_url` string, nullable
          - `last_instructed_sales_at` string, date-time, nullable
          - `last_instructed_lettings_at` string, date-time, nullable
          - `last_made_available_for_sale_at` string, date-time, nullable
          - `last_made_available_to_let_at` string, date-time, nullable
          - `last_exchanged_at` string, date-time, nullable
          - `last_completed_at` string, date-time, nullable
          - `created_at` string, date-time
          - `updated_at` string, date-time
          - `custom_meta_data` union
            - object
            - unknown[]
              - …
          - `lead_source` string, nullable
          - `publish_after` string, date-time, nullable
          - `archived_at` string, date-time, nullable
          - `virtual_tour` string, uri, nullable
          - `property_urls` object[], nullable
            - `title` string, required
            - `type` 'image' | 'floor_plan' | 'brochure' | 'virtual_tour' | 'audio_tour' | 'ipack', required
            - `url` string, uri, required
        - `relationships` object, nullable
          - `branch` object: Inheritable schema for 1:1 relationships. Data may be null if the relationship is empty.
            - `data` object, nullable
              - …
            - `links` object
              - …
        - `meta` Meta: The server's implementation.
      - IncludedLettingsListing
        - `type` 'lettings_listing', required
        - `id` string, uuid, required
        - `attributes` object
          - `brand_id` string, uuid
          - `price_pcm` integer
          - `deposit` integer
          - `let_type` string
          - `allows_pets` boolean
          - `available_from` string
          - `furnished` boolean
          - `is_student_rental` boolean
          - `is_shared_accommodation` boolean
          - `min_tenancy_period` string
          - `archived` boolean
          - `is_low_profile` boolean
          - `is_not_in_property_feed_api` boolean
          - `spectre_social_campaigns` boolean
          - `spectre_email_campaigns` boolean
          - `full_description` string
          - `short_description` string
          - `location_summary` string
          - `has_parking` boolean
          - `virtual_tour` string
          - `status` string
          - `made_available_to_let_at` string, date-time, nullable
          - `created_at` string, date-time
          - `updated_at` string, date-time
          - `deleted_at` string, date-time, nullable
        - `relationships` object, nullable
        - `meta` Meta: The server's implementation.
      - IncludedApplicant
        - `type` 'applicant', required
        - `id` string, uuid, required
        - `attributes` object
          - `applicant_type` 'sales' | 'lettings'
          - `name` string
          - `financial_position` string, nullable
          - `buying_position` string
          - `letting_position` 'Homeowner' | 'Renting' | 'Living with Family' | 'Selling' | 'Other' | 'null', nullable
          - `requirements` object
            - `min_price` integer, nullable
            - `max_price` integer, nullable
            - `min_bedrooms` integer, nullable
            - `preferred_bedrooms` integer, nullable
            - `desired_move_in_date` string, date, nullable
            - `desired_tenancy_period` integer, nullable
            - `furnished` boolean, nullable
            - `pets_allowed` boolean, nullable
            - `outside_space` 'Strong Preference' | 'Don't Mind' | 'Would Prefer' | 'Won't Consider' | 'Might Consider' | 'Must Have'
            - `min_land_area` integer, nullable
            - `garage` 'Strong Preference' | 'Don't Mind' | 'Would Prefer' | 'Won't Consider' | 'Might Consider' | 'Must Have'
            - `new_build` 'Strong Preference' | 'Don't Mind' | 'Would Prefer' | 'Won't Consider' | 'Might Consider' | 'Must Have'
            - `retirement_property` 'Strong Preference' | 'Don't Mind' | 'Would Prefer' | 'Won't Consider' | 'Might Consider' | 'Must Have'
            - `min_parking` integer, nullable
            - `preferred_parking` integer, nullable
            - `property_type_preference` object
            - `new_property_type_preference` object
            - `areas` string[]
          - `active` boolean
          - `created_at` string, date-time
          - `updated_at` string, date-time
          - `lead_rating` 'hot' | 'warm' | 'cold' | 'null', nullable
        - `relationships` object, nullable
          - `people` object: This is a inheritable schema to allow you to easily add relationships to your main schemas. This should be used for `1:n` relationships.
            - `data` object[]
              - …
            - `links` object
              - …
        - `meta` Meta: The server's implementation.
      - IncludedNotes
        - `type` 'note', required
        - `id` string, uuid, required
        - `attributes` object
          - `body` string, nullable
          - `author` string, nullable
          - `pinned_at` string, date-time, nullable
          - `created_at` string, date-time
          - `updated_at` string, date-time
        - `relationships` object, nullable
        - `meta` Meta: The server's implementation.
      - IncludedPerson
        - `type` 'person', required
        - `id` string, uuid, required
        - `attributes` object
          - `full_name` string
          - `title` string, nullable
          - `first_name` string
          - `last_name` string
          - `address` AddressSimple
            - `single_line` string
            - `anon_single_line` string
            - `building_number` string, nullable
            - `building_name` string, nullable
            - `street` string, nullable
            - `line_1` string
            - `line_2` string, nullable
            - `line_3` string, nullable
            - `line_4` string, nullable
            - `town` string, nullable
            - `country` string
            - `postcode` string
            - `udprn` string, nullable
            - `geo` object
              - …
            - `royal_mail` object, nullable
              - …
            - `street_group_property_id` string, nullable
          - `telephone_numbers` TelephoneNumberSimple[]
            - `value` string
            - `notes` string, nullable
            - `primary` boolean
          - `email_addresses` EmailAddressSimple[]
            - `value` string, email
            - `notes` string, nullable
            - `primary` boolean
          - `marketing_consent` boolean, nullable
          - `contact_preferences` object
            - `email` boolean
            - `post` boolean
            - `text` boolean
            - `phone` boolean
          - `preferred_language` 'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'sh' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zh' | 'zu': The person's preferred language, as a two-letter ISO 639-1 language code.
          - `statuses` object
            - `vendor` 'null' | 'Current' | 'Previous', nullable
            - `landlord` 'null' | 'Current' | 'Previous', nullable
            - `tenant` 'null' | 'Current' | 'Previous', nullable
          - `created_at` string, date-time
          - `updated_at` string, date-time
        - `relationships` object, nullable
        - `meta` Meta: The server's implementation.
  - `links` Links: Links object - JSON:API Standard.
    - `self` string
    - `first` string
    - `next` string
    - `prev` string
    - `last` string
  - `meta` Pagination: Pagination object - JSON:API Standard.
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
  - `jsonapi` JsonApi: The server's implementation.
    - `version` string
    - `meta` Meta: The server's implementation.

## 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.
- `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-04** `b01c2825aba9`: 4 info
  - added the optional property `included/items/anyOf[subschema #2: Property (included)]/allOf[subschema #2]/attributes/lease_start_date` to the response with the `200` status
  - added the optional property `included/items/anyOf[subschema #2: Property (included)]/allOf[subschema #2]/attributes/lease_term_years` to the response with the `200` status
  - added the optional property `included/items/anyOf[subschema #2: Property (included)]/allOf[subschema #2]/attributes/material_information/lease_start_date` to the response with the `200` status
  - added the optional property `included/items/anyOf[subschema #2: Property (included)]/allOf[subschema #2]/attributes/material_information/lease_term_years` to the response with the `200` status
- **2026-09-03** `6ed52b1e6e1e`: 3 info
  - added the optional property `included/items/anyOf[subschema #2: Property (included)]/allOf[subschema #2]/attributes/last_made_available_for_sale_at` to the response with the `200` status
  - added the optional property `included/items/anyOf[subschema #2: Property (included)]/allOf[subschema #2]/attributes/last_made_available_to_let_at` to the response with the `200` status
  - added the optional property `included/items/anyOf[subschema #3: Lettings Listing (included)]/allOf[subschema #2]/attributes/made_available_to_let_at` to the response with the `200` status
- …earlier changes not shown

[Operation history](https://skmtc.dev/street/apis/street-open-api/changes/lettings-offers/get.md)

---

[API](https://skmtc.dev/street/apis/street-open-api.md) - [All operations](https://skmtc.dev/street/apis/street-open-api/llms.txt) - [OpenAPI document](https://skmtc.dev/street/apis/street-open-api/revisions/f6566b8fcd77?raw)