Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
units
/
get_by_uuids
[
  {
    "unitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "facilityUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "unitNumber": "A101",
    "status": "VACANT",
    "currentTenantUuid": "5a6b7c8d-9e0f-1a2b-3c4d-5e6f7a8b9c0d",
    "currentRentalRecordUuid": "6b7c8d9e-0f1a-2b3c-4d5e-6f7a8b9c0d1e",
    "unitGroupUuid": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "width": 10.5,
    "height": 8,
    "depth": 10,
    "monthlyRentAmount": 125,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "type": "Climate-Controlled",
    "tier": "Premium",
    "amenities": [
      "Climate-Controlled",
      "Digital Lock"
    ]
  }
]

Headers

​
x-api-key
any

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
​
unitUuids
string<uuid>[]
required

Array of unit UUIDs to retrieve details for

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

Response

Unit details retrieved successfully

​
unitUuid
string<uuid>
required

Unit UUID

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
facilityUuid
string<uuid>
required

Facility UUID where the unit is located

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

​
unitNumber
string
required

Unit number identifier

Example:

"A101"

​
status
enum<string>
required

Unit occupancy status

Available options:
VACANT,
RESERVED,
OCCUPIED,
UNRENTABLE,
OWNER OCCUPIED
Example:

"VACANT"

​
currentTenantUuid
string<uuid> | null
required

Account UUID of the current tenant (active rental record)

Example:

"5a6b7c8d-9e0f-1a2b-3c4d-5e6f7a8b9c0d"

​
currentRentalRecordUuid
string<uuid> | null
required

Unit rental record UUID of the active rental

Example:

"6b7c8d9e-0f1a-2b3c-4d5e-6f7a8b9c0d1e"

​
unitGroupUuid
string<uuid> | null
required

Unit group UUID this unit belongs to

Example:

"7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f"

​
width
number
required

Unit width

Example:

10.5

​
height
number
required

Unit height

Example:

8

​
depth
number
required

Unit depth

Example:

10

​
monthlyRentAmount
number
required

Monthly rent amount (Integer)

Example:

125

​
createdAt
string<date-time>
required

Timestamp when the unit was created

Example:

"2024-01-15T10:30:00.000Z"

​
updatedAt
string<date-time>
required

Timestamp when the unit was last updated

Example:

"2024-01-20T15:45:00.000Z"

​
type
string | null

Unit type description

Example:

"Climate-Controlled"

​
tier
string | null

Unit tier description

Example:

"Premium"

​
amenities
string[] | null

Unit amenities

Example:
["Climate-Controlled", "Digital Lock"]