Skip to main content
DELETE
Archive

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

id
string
required

Response

Success

id
string
required
line1
string
required
line2
string | null
required
town
string | null
required
postcode
string
required
uprn
string | null
required
landlordContactId
string | null
required
landlordCompanyId
string | null
required
type
enum<string> | null
required
Available options:
flat,
house,
maisonette,
bungalow,
studio,
hmo,
other
beds
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
furnishing
enum<string> | null
required
Available options:
unfurnished,
part_furnished,
furnished
status
enum<string> | null
required
Available options:
available,
under_offer,
let,
for_sale,
sstc,
sold,
withdrawn
serviceLevel
enum<string> | null
required
Available options:
let_only,
rent_collection,
fully_managed
feePercent
required
blockId
string | null
required
estateId
string | null
required
archivedAt
string | null
required
createdAt
string
required
units
object[]
required