Property Management

Copy page

Rooms API

Define the interior layout of rental units — bedrooms, living rooms, kitchens, bathrooms. Room details appear on the lease document and are required for habitable surface area calculations under French law.

Quick Example

Code
 
curl -X POST https://api.faireplace.com/api/places/<place_uuid>/estates/<estate_uuid>/rooms \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "room_type_id": "<room_type_uuid>",
    "name": "Sejour",
    "area": 18.5
  }'

Common Workflows

Define a T2 apartment layout

1. POST rooms — Sejour (18.5 m2)
2. POST rooms — Chambre (12.0 m2)
3. POST rooms — Cuisine (8.0 m2)
4. POST rooms — Salle de bain (4.5 m2)

Tip: Get room types with GET /api/types/rooms. The counts_towards_habitable flag determines which rooms count toward surface habitable (living area under French law).

---

Overview

Rooms are the most granular level in the property hierarchy (Places > Estates > Rooms) and provide:

• Space Management: Detailed room-by-room property layouts
• Room Types: Categorization by function (bedroom, bathroom, kitchen, etc.)
• Area Tracking: Square footage and dimensions for each room
• Feature Management: Room-specific features and amenities
• Equipment Integration: Room-level equipment and fixtures

Authentication

All endpoints require authentication with PropertiesRead, PropertiesWrite, or PropertiesDelete permissions.

Base URL

Room endpoints are nested: /api/places/{place_id}/estates/{estate_id}/rooms

---

Core Operations

List Rooms

GET /api/places/{place_id}/estates/{estate_id}/rooms

Response:

Code
 
[
  {
    "id": "room-550e8400-e29b-41d4-a716-446655440000",
    "estate_id": "550e8400-e29b-41d4-a716-446655440001",
    "room_type": "Bedroom",
    "name": "Chambre parentale",
    "area": 15.5,
    "description": "Chambre avec salle de bain attenante",
    "features": ["EnSuiteBathroom", "BuiltInWardrobe", "Balcony"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

Create Room

POST /api/places/{place_id}/estates/{estate_id}/rooms

Request:

Code
 
{
  "room_type": "Kitchen",
  "name": "Cuisine",
  "area": 12.0,
  "description": "Cuisine equipee avec ilot central",
  "features": ["Island", "Dishwasher", "InductionHob"]
}

Get Room

GET /api/places/{place_id}/estates/{estate_id}/rooms/{room_id}

Update Room

PUT /api/places/{place_id}/estates/{estate_id}/rooms/{room_id}

Delete Room

DELETE /api/places/{place_id}/estates/{estate_id}/rooms/{room_id}

---

Room Types

Common room types include:

• Bedroom - Sleeping rooms
• Bathroom - Full bathrooms
• Kitchen - Cooking areas
• LivingRoom - Main living spaces
• DiningRoom - Dining areas
• Office - Work spaces
• Storage - Storage areas
• Balcony - Outdoor spaces
• Garage - Parking spaces

---

Features and Amenities

Rooms can have various features:

• Bedroom: EnSuiteBathroom, BuiltInWardrobe, Balcony
• Kitchen: Island, Dishwasher, InductionHob, Oven
• Bathroom: Bathtub, Shower, DoubleBasin, ToiletSeparate
• General: AirConditioning, Heating, NaturalLight

---

Error Responses

400 Bad Request

Code
 
{
  "error": "ValidationError",
  "message": "Area must be greater than 0"
}

404 Not Found

Code
 
{
  "error": "NotFound",
  "message": "Room not found in specified estate"
}

---

Common Use Cases

• Property Layout: Create detailed floor plans with room-by-room breakdown
• Space Management: Track usable area and room functions
• Equipment Assignment: Associate equipment with specific rooms
• Rental Marketing: Highlight room features in property listings

Integration Notes

• Equipment: Rooms can contain equipment and fixtures
• Area Calculations: Room areas contribute to estate total area
• Property Hierarchy: Rooms must belong to valid estates within places