Properties

Search properties.

Search properties by name or reference.

get/properties/search

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/properties/search
  • Auth: OAuth 2 (password, token URL https://api.floorworks.co.uk/api/v1/auth)

Query parameters

qstring required

Search query string.

Response

Matching properties

addr_line_1string nullable

Address line 1.

addr_line_2string nullable

Address line 2.

addr_citystring nullable

City.

addr_pcodestring nullable

Postcode / ZIP code.

addr_countystring nullable

County / state.

addr_countrystring nullable

Country.

longitudenumber double nullable

Longitude coordinate.

latitudenumber double nullable

Latitude coordinate.

eastingsnumber double nullable

OS easting coordinate.

northingsnumber double nullable

OS northing coordinate.

referencestring

Auto generated reference of the document.

reference_externalstring

Vendor invoice ID for external reference. Use this field to filter and retrieve all the orders that have this ID. Used for filtering.

manager_contact_idstring uuid

Manager Id.

market_idinteger nullable

Market segment ID.

property_typeinteger nullable

Property type ID (see /properties/types/property_types).

property_accessinteger nullable

Access type ID (see /properties/types/property_access).

property_parkinginteger nullable

Parking type ID (see /properties/types/parking_types).

building_typeinteger nullable

Building type ID (see /properties/types/building_types).

building_floorsinteger nullable

Total number of floors in the building.

building_entranceinteger nullable

Building entrance type ID (see /properties/types/building_entrances).

parking_controlinteger nullable

Parking control type ID (see /properties/types/parking_control).

property_floorinteger nullable

Floor number within the building.

residentsinteger nullable

Number of residents at the property.

key_searchstring nullable

Key/fob reference for property access.

key_personinteger nullable

Contact ID of the key person for this property.

access_notesstring nullable

Access notes for the property.

access_oohstring nullable

Out-of-hours access instructions.

notesstring nullable

General notes.

idnumber

ID.

uuidstring uuid

UUID.

time_createdstring YYYY-MM-DD

Creation date

time_modifiedstring YYYY-MM-DD

Last modification date

Example response

[
  {
    "id": 12345,
    "time_created": "2025-08-17",
    "time_modified": "2025-08-18"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.