> ## Documentation Index
> Fetch the complete documentation index at: https://developers.apartmentiq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Amenities

> List active amenities available for property filtering.



## OpenAPI

````yaml /openapi/v2/schema.json get /amenities
openapi: 3.1.0
info:
  title: ApartmentIQ API V2
  version: 2.0.0
  termsOfService: https://www.getapartmentiq.com/terms
  x-logo:
    url: https://developers.apartmentiq.io/logo.svg
    altText: ApartmentIQ
  description: >-
    ApartmentIQ API V2 endpoints for account discovery, search, and bulk Explore
    data.
servers:
  - url: https://data.apartmentiq.io/apartmentiq/api/v2
security:
  - bearerAuth: []
tags:
  - name: Accounts
    description: Account discovery endpoints.
  - name: Amenities
    description: Amenity discovery endpoints.
  - name: Properties
    description: Property search endpoints.
  - name: Markets
    description: Market and geo-boundary search endpoints.
  - name: Organizations
    description: Organization search endpoints.
  - name: Bulk
    description: Bulk property, market, quota, and forecast exports.
paths:
  /amenities:
    get:
      tags:
        - Amenities
      summary: List Amenities
      description: List active amenities available for property filtering.
      operationId: listV2Amenities
      parameters:
        - name: account_id
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/AccountId'
      responses:
        '200':
          description: Active amenities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAmenitiesResponse'
              example:
                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
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountAccessForbidden'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    AccountId:
      anyOf:
        - type: integer
        - type: string
      description: ApartmentIQ account ID used to set the request account context.
    ListAmenitiesResponse:
      type: object
      properties:
        amenities:
          type: array
          items:
            $ref: '#/components/schemas/Amenity'
          description: Active amenities available for filtering.
      required:
        - amenities
      additionalProperties: false
      description: List of active amenities available for filtering.
    Amenity:
      type: object
      properties:
        id:
          type: integer
          description: ApartmentIQ amenity ID.
        name:
          type: string
          description: Amenity display name.
        category:
          type: string
          description: Amenity category.
      required:
        - id
        - name
        - category
      additionalProperties: false
      description: Amenity that can be used in ApartmentIQ property filters.
    Error:
      type: object
      description: Error response payload.
      properties:
        error:
          type: string
          description: Short error message.
        message:
          type: string
          description: Additional error details, when available.
        quota_limit:
          type: integer
          description: Quota limit that applied to the request, when relevant.
        quota_usage:
          type: integer
          description: Quota already used, when relevant.
      required:
        - error
      additionalProperties: true
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing authentication.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    AccountAccessForbidden:
      description: Forbidden - The user lacks access to the requested account.
    RateLimitExceeded:
      description: >-
        Rate limit exceeded. Inspect the rate limit headers and wait before
        retrying.
      headers:
        X-RateLimit-Limit:
          description: The limit that applied to the request.
          schema:
            type: string
        X-RateLimit-Reset-After:
          description: The rate limit window length, in seconds.
          schema:
            type: string
        X-RateLimit-Reset:
          description: Unix timestamp when the current window resets.
          schema:
            type: string
        Retry-After:
          description: Seconds to wait before retrying the request.
          schema:
            type: string
      content:
        text/plain:
          schema:
            type: string
          example: |
            You have exceeded the rate limit for this API.
    InternalServerError:
      description: An unexpected error occurred while processing the request.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````