Amenities

  1. Overview
  2. List amenities
  3. Get a single amenity

Overview

This resource represents the available Amenities, that can be assigned to the Rentals by creating Rentals Amenities.

Parameters

Name Type Read/Write Description
id Integer Read Amenity’s id.
key String Read Amenity’s key.
title Object Read Amenity’s title, list of locales described in enums section.
created_at Time Read Amenity’s create time.
updated_at Time Read Amenity’s update time.

List amenities

List all the existing amenities.

GET /amenities

Response

{
  "amenities": [
    {
      "id": 1,
      "key": "internet",
      "title": {
        "en": "Internet"
      }
    }
  ],
  "meta": {
  }
}

Get a single amenity

Returns a single amenity identified by ID.

GET /amenities/:amenity_id

Response

{
  "amenities": [
    {
      "id": 1,
      "key": "internet",
      "title": {
        "en": "Internet"
      }
    }
  ],
  "meta": {
  }
}