Sign in

v1

latestSwagger 2.02026-07-14453366.1 KB
PropertyController

Get a specific property given its unique Object ID (OID)

get/v2/tier2/{shortName}/property/properties/{propertyID}

Path parameters

shortNamestring required

The unique client short-name

propertyIDstring required

The unique ID of the Property

Response

OK

Areastring

The area the property is located in.

Branchstring

The branch the block, property or room is assigned to

Descriptionstring

The block, property or room description.

ETagstring

A unique identifier defining the object and change revision.

FullAddressstring

The full address of a block, property or room, formatted with line breaks such that it may be used on a letter directly.

GlobalReferencestring

The global reference to this block, property or room

MainPhotostring

Gets the main photo, if there is one.

ManagedByStaffstring

The staff memeber that manages the block, property or room

OIDstring

The unique Object ID (OID).

PropertySourcestring

The block, property or room source type

PropertyType'House' | 'FlatApartment' | 'Bungalow' | 'Land' | 'HouseFlatShare' | 'GarageParking' | 'CommercialProperty' | 'Block' | 'TerracedHouse' | 'EndTerraceHouse' | 'SemiDetachedHouse' | 'DetachedHouse' | 'SemiDetachedBungalow' | 'TownHouse' | 'Cottage' | 'ServicedApartment' | 'Studio' | 'Apartment' | 'Barn' | 'FarmHouse' | 'Penthouse' | 'BuildingPlot' | 'DetachedBungalow' | 'LinkDetached' | 'MidTerracedBungalow' | 'LandResidential'

The block or property type.

RoomNamestring

The room name (if applicable).

VideoURLstring

URL of the video linked to the property