--- title: "Get a single Property Key" method: GET path: "/property-keys/{property_key_id}" tags: ["Property Keys"] --- # Get a single Property Key `GET /property-keys/{property_key_id}` ## Request - Base URL: `https://street.co.uk/open-api/v1` - URL: `https://street.co.uk/open-api/v1/property-keys/{property_key_id}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint retrieves a single Property Key by its `UUID`. ## Path parameters - `property_key_id` string, uuid, required ## Query parameters - `include` string[] ## Response `200` OK. - object - `data` PropertyKeys - `id` string, uuid - `type` 'property_key' - `attributes` object - `ident` string - `description` string, nullable - `status` 'Checked In' | 'Checked Out' - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time, nullable - `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 - … - `included` 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 - `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 - `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 - unknown - `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[] - 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 - `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 - … - `meta` Meta: The server's implementation. - `links` IncludedLinks - `self` union - string, uri-reference: a string containing the link's URL - object - `href` string, uri-reference, required: a string containing the link's URL - `meta` Meta: The server's implementation. - `related` union - string, uri-reference: a string containing the link's URL - object - `href` string, uri-reference, required: a string containing the link's URL - `meta` Meta: The server's implementation. - `meta` object - `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. - `404`: The HTTP 404 Not Found response status code indicates that the server cannot find the requested resource. - `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 #1: Property (included)]/allOf[subschema #2]/attributes/lease_start_date` to the response with the `200` status - added the optional property `included/items/anyOf[subschema #1: Property (included)]/allOf[subschema #2]/attributes/lease_term_years` to the response with the `200` status - added the optional property `included/items/anyOf[subschema #1: 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 #1: Property (included)]/allOf[subschema #2]/attributes/material_information/lease_term_years` to the response with the `200` status - **2026-09-03** `6ed52b1e6e1e`: 2 info - added the optional property `included/items/anyOf[subschema #1: 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 #1: Property (included)]/allOf[subschema #2]/attributes/last_made_available_to_let_at` to the response with the `200` status [Operation history](https://skmtc.dev/street/apis/street-open-api/changes/property-keys/:property_key_id/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)