Types

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.).

get/types/estates

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/types/estates
  • Auth: HTTP bearer

Response

Property types retrieved successfully

idstring uuid nullable required

Unique identifier of the property type

namestring nullable required

Property type name

created_atstring date-time nullable required

Creation date and time

updated_atstring date-time nullable required

Last modification date and time

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "3-bedroom apartment",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.