List Available Units

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.

<Badge>Available by Request</Badge> 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. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note> <Note> 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. </Note>

Path parameters

propertyIdstringRequired

The id of the property

Response

Expected response to a valid request

metaobjectOptional

datalist of objectsOptional

1	{
2	"meta": {
3	"applyNowEnabled": true,
4	"propertyType": "propertyType",
5	"count": 1
6	},
7	"data": [
8	{
9	"unitId": "unitId",
10	"unitNumber": "unitNumber",
11	"quotingRent": 1.1,
12	"availableDate": "availableDate",
13	"availableThroughDate": "availableThroughDate",
14	"amenities": [
15	"amenities"
16	]
17	}
18	]
19	}