Skip to main content
GET
/
amenities
List Amenities
curl --request GET \
  --url https://data.apartmentiq.io/apartmentiq/api/v2/amenities \
  --header 'Authorization: Bearer <token>'
{
  "amenities": [
    {
      "id": 101,
      "name": "Swimming Pool",
      "category": "Community"
    },
    {
      "id": 118,
      "name": "Fitness Center",
      "category": "Community"
    },
    {
      "id": 244,
      "name": "In-Unit Washer and Dryer",
      "category": "Unit"
    },
    {
      "id": 317,
      "name": "Covered Parking",
      "category": "Parking"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
account_id
required

ApartmentIQ account ID used to set the request account context.

Response

Active amenities.

List of active amenities available for filtering.

​
amenities
object[]
required

Active amenities available for filtering.