List Available Units

GET

https://api.fortresstech.io/v1/properties/:propertyId/availableUnits

GET

/v1/properties/:propertyId/availableUnits

curl https://api.fortresstech.io/v1/properties/propertyId/availableUnits \
     -H "x-api-key: <apiKey>"

200Retrieved

{
  "meta": {
    "applyNowEnabled": true,
    "propertyType": "string",
    "count": 1,
    "special": {
      "description": "string",
      "startDate": "2024-01-15T09:30:00Z"
    }
  },
  "data": [
    {
      "unitId": "string",
      "unitNumber": "string",
      "quotingRent": 1.1,
      "availableDate": "2023-01-15",
      "availableThroughDate": "2023-01-15",
      "amenities": [
        "string"
      ],
      "charges": {
        "monthlyRecurring": [
          {
            "label": "string",
            "value": 1.1
          }
        ],
        "oneTime": [
          {
            "label": "string",
            "value": 1.1
          }
        ]
      },
      "floorPlan": {
        "name": "string",
        "imageName": "string",
        "beds": 1.1,
        "baths": 1.1,
        "squareFeet": 1.1,
        "marketingDescription": "string"
      }
    }
  ]
}

Available by Request

List the currently available units for a property, including quoting rent, availability dates, amenities, and floor plan details. Intended for Internet Listing Service (ILS) and syndication partners publishing live availability.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Filtering, sorting, field selection, and pagination are not available on this endpoint. It always returns the complete set of currently available units for the requested property, and the fields, sort, filter, page, and limit query parameters are ignored.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

propertyIdstringRequiredformat: "uuid"

The id of the property

Response

Expected response to a valid request

metaobjectOptional

datalist of objectsOptional