Public Tools

Get default referentials for the landing wizard

Returns the default global referentials (stable UUIDs): lease types, estate types and place types, plus the default place type and country. Consumed by the landing wizard. Public, unauthenticated tool. Cacheable.

Example

curl https://api.faireplace.com/api/public/tools/referentials

get/public/tools/referentials

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/public/tools/referentials
Auth: none required

Response

Default referentials.

default_place_type_idstring uuid nullable

Default global place_type UUID (null if not seeded).

default_country_idstring uuid nullable

Default country UUID (France; null if absent).

Example response

{
  "lease_types": [
    {
      "name": "Bail vide (loi 89)"
    }
  ],
  "estate_types": [
    {
      "name": "Appartement"
    }
  ],
  "place_types": [
    {
      "name": "Immeuble"
    }
  ]
}

Changes

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