Skip to main content
GET
/
shopping
/
{portfolio}
/
v1
/
facilities
/
{facilityUuid}
/
unitGroups
Get unit groups for a facility
curl --request GET \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/facilities/{facilityUuid}/unitGroups \
  --header 'x-api-key: <x-api-key>'
[
  {
    "unitGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "unitGroupDepth": 123,
    "unitGroupWidth": 123,
    "unitGroupHeight": 123,
    "amenities": [
      {
        "key": "<string>",
        "present": true
      }
    ],
    "types": {
      "vehicleRv": true,
      "selfStorage": true
    },
    "availableUnitCount": 123,
    "unitCount": 123,
    "description": "<string>",
    "facilityName": "<string>",
    "facilityAddress": "<string>",
    "currentStreetRate": 123,
    "currentWebRate": 123,
    "unitType": "<string>",
    "bestAutoAppliedPromotion": {
      "facilityUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "promotionUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "promotionName": "<string>",
      "highestDiscountAmount": 123
    },
    "unitTypeImage": "<string>"
  }
]

Headers

​
x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

​
facilityUuid
string
required

Response

200 - application/json

Unit groups available for rent at the provided facility

​
unitGroupUuid
string<uuid>
required
​
unitGroupDepth
number
required
​
unitGroupWidth
number
required
​
unitGroupHeight
number
required
​
amenities
object[]
required
​
types
object
required
​
availableUnitCount
number
required
​
unitCount
number
required
​
description
string
required
​
facilityName
string
required
​
facilityAddress
string
required
​
currentStreetRate
number
​
currentWebRate
number
​
unitType
string
​
bestAutoAppliedPromotion
object

Best auto-applied promotion for the facility

​
unitTypeImage
string | null