Skip to main content
GET
/
shopping
/
{portfolio}
/
v1
/
unitGroups
/
{unitGroupUuid}
Get unit group details
curl --request GET \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/unitGroups/{unitGroupUuid} \
  --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>",
  "additionalServices": {
    "itemUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "priceInPennies": 123,
    "isRecurring": false,
    "isRequiredAtMoveIn": false,
    "entityAttributeOrganizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "feeType": "PERCENTAGE"
  },
  "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

​
unitGroupUuid
string
required

Query Parameters

​
isForBusiness
boolean
required

Response

200 - application/json

The additional services which can be provided to a lead renting from this unit group

​
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
​
additionalServices
object
required
​
currentStreetRate
number
​
currentWebRate
number
​
unitType
string
​
bestAutoAppliedPromotion
object

Best auto-applied promotion for the facility

​
unitTypeImage
string | null