Floorplans
A floorplan is a reusable layout under a property: its bedroom and bathroom counts, typical size, and advertised rent range. Units then reference a floorplan to inherit its shape.
Fields
| Field | Type | Writable | Description |
|---|---|---|---|
id | number | read-only | RentSimple identifier |
propertyId | number | create-only | The property this floorplan belongs to |
name | string | required | Display name (e.g. B2 — Two Bedroom) |
bedrooms | number | required | Bedroom count (0 for studio) |
bathrooms | number | required | Bathroom count (halves allowed, e.g. 1.5) |
squareFeet | number | optional | Typical interior size |
minRent / maxRent | number | optional | Advertised rent range in whole dollars |
description | string | optional | Shown to prospects and used by the agent |
amenities | string[] | optional | In-suite features (e.g. ["In-unit laundry"]) |
images | string[] | optional | Image URLs |
externalId | string | optional | Your own identifier |
createdAt / updatedAt | string | read-only | ISO-8601 timestamps |
List filters: propertyId, bedrooms
Parent link is fixed. propertyId is set on create and cannot be changed afterward.
Example: list two-bedroom floorplans at a property
Request
curl -X GET "https://rentsimple.ai/api/v1/floorplans?propertyId=412&bedrooms=2" \
-H "Authorization: Bearer $RENTSIMPLE_API_KEY"Response — 200 OK
{
"data": [
{
"id": 1287,
"propertyId": 412,
"name": "B2 — Two Bedroom",
"bedrooms": 2,
"bathrooms": 2,
"squareFeet": 1050,
"minRent": 3400,
"maxRent": 3650,
"description": null,
"amenities": ["In-unit laundry"],
"images": [],
"externalId": null,
"createdAt": "2026-01-12T09:00:00Z",
"updatedAt": "2026-06-01T18:30:00Z"
}
]
}Before you delete. A floorplan must be empty before it can be deleted, or the request returns 409 Floorplan not empty.
Last updated on