Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
unitGroups
/
sizeAndType
/
get_by_uuids
Get size-and-type unit group details by UUIDs
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "sizeAndTypeUnitGroupUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'
[
  {
    "sizeAndTypeUnitGroupUuid": "22d0bbc0-17f4-11f1-8e7c-67a9b4f331ad",
    "length": 10.5,
    "width": 10.5,
    "height": 10.5,
    "area": "100 sq. ft.",
    "unitType": "Covered Parking",
    "entityAttributeOrganizationUuid": "6fe75622-7de5-11f0-9798-e13a04f5cbb4",
    "unitGroups": [
      {
        "unitGroupUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "description": "Essential",
        "currentStreetRate": 15000,
        "currentWebRate": 12000,
        "baseStreetRate": 15000,
        "baseWebRate": 12000,
        "numUnits": 10,
        "numVacantUnits": 5,
        "averageCurrentRentInPennies": 145.5,
        "ratePlanUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "amenities": [
          {
            "amenityUuid": "123e4567-e89b-12d3-a456-426614174000",
            "description": "Climate Control"
          }
        ]
      }
    ]
  }
]

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

Body

application/json
​
sizeAndTypeUnitGroupUuids
string<uuid>[]
required

Array of sizeAndTypeUnitGroupUuids to retrieve details for

Example:
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "3fa85f64-5717-4562-b3fc-2c963f66afa7"
]

Response

Size-and-type unit group details retrieved

​
sizeAndTypeUnitGroupUuid
string<uuid>
required

Size-and-type unit group UUID

Example:

"22d0bbc0-17f4-11f1-8e7c-67a9b4f331ad"

​
length
number | null
required

Unit depth (length)

Example:

10.5

​
width
number | null
required

Unit width

Example:

10.5

​
height
number | null
required

Unit height

Example:

10.5

​
area
string | null
required

Calculated area (width × length)

Example:

"100 sq. ft."

​
unitType
string | null
required

Unit type description

Example:

"Covered Parking"

​
entityAttributeOrganizationUuid
string<uuid> | null
required

Entity attribute organization UUID (unit type)

Example:

"6fe75622-7de5-11f0-9798-e13a04f5cbb4"

​
unitGroups
object[]
required

Unit groups belonging to this size-and-type group