Property, room, and equipment types
List place types
Retrieves the list of all available place types in the system. Place types define the category of a property (e.g., Residential building, Detached house, Commercial premises).
List place types › Responses
Place types retrieved successfully
idUnique identifier of the place type
namePlace type name
created_atCreation date and time
updated_atLast modification date and time
Create a new place type
Creates a new place type in the system. This operation requires write permissions on properties.
Create a new place type › Request Body
nameName of the place type to create
Create a new place type › Responses
Place type created successfully
idUnique identifier of the place type
namePlace type name
created_atCreation date and time
updated_atLast modification date and time
List property types
Retrieves the list of all available property types in the system. Property types define the configuration of a dwelling (e.g., Apartment, Studio, 1-bedroom, 2-bedroom, 3-bedroom, etc.).
List property types › Responses
Property types retrieved successfully
idUnique identifier of the property type
nameProperty type name
created_atCreation date and time
updated_atLast modification date and time
Create a new property type
Creates a new property type in the system. This operation requires write permissions on properties.
Create a new property type › Request Body
nameName of the property type to create
Create a new property type › Responses
Property type created successfully
idUnique identifier of the property type
nameProperty type name
created_atCreation date and time
updated_atLast modification date and time
List room types
Retrieves the list of all available room types in the system.
Room types define the different rooms of a property (e.g., Living room, Bedroom, Kitchen, Bathroom, etc.).
The counts_towards_habitable field indicates whether the room counts toward the habitable area according to the Carrez Law.
List room types › Responses
Room types retrieved successfully
idUnique identifier of the room type
nameRoom type name
counts_towards_habitableIndicates whether this room counts toward the habitable area (Carrez law)
created_atCreation date and time
updated_atLast modification date and time
Create a new room type
Creates a new room type in the system.
This operation requires write permissions on properties.
The counts_towards_habitable field determines whether the room counts toward the habitable area according to the Carrez Law.
Create a new room type › Request Body
nameName of the room type to create
counts_towards_habitableIndicates whether this room counts toward the habitable area (Carrez law)
Create a new room type › Responses
Room type created successfully
idUnique identifier of the room type
nameRoom type name
counts_towards_habitableIndicates whether this room counts toward the habitable area (Carrez law)
created_atCreation date and time
updated_atLast modification date and time
List equipment types
Retrieves the list of all available equipment types in the system. Equipment types define the equipment available in a property (e.g., Heating, Air conditioning, Elevator, etc.).
List equipment types › Responses
Equipment types retrieved successfully
idUnique identifier of the equipment type
nameEquipment type name
created_atCreation date and time
updated_atLast modification date and time
Create a new equipment type
Creates a new equipment type in the system. This operation requires write permissions on properties.
Create a new equipment type › Request Body
nameName of the equipment type to create
Create a new equipment type › Responses
Equipment type created successfully
idUnique identifier of the equipment type
nameEquipment type name
created_atCreation date and time
updated_atLast modification date and time