Unit Groups
Get size-and-type unit group details by UUIDs
Returns details for specified size-and-type unit groups associated with a facility
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"
]
}
'import requests
url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids"
payload = { "sizeAndTypeUnitGroupUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sizeAndTypeUnitGroupUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
})
};
fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sizeAndTypeUnitGroupUuids' => [
'3fa85f64-5717-4562-b3fc-2c963f66afa6',
'3fa85f64-5717-4562-b3fc-2c963f66afa7'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids"
payload := strings.NewReader("{\n \"sizeAndTypeUnitGroupUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sizeAndTypeUnitGroupUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sizeAndTypeUnitGroupUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"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"
}
],
"canShowUnitGroupTenantPortal": true
}
]
}
]Headers
Api key required to authenticate your request. Please reach out to monument for a key.
Example:
"monument-2230012-2312321"
Path Parameters
Body
application/json
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
Size-and-type unit group UUID
Example:
"22d0bbc0-17f4-11f1-8e7c-67a9b4f331ad"
Unit depth (length)
Example:
10.5
Unit width
Example:
10.5
Unit height
Example:
10.5
Calculated area (width × length)
Example:
"100 sq. ft."
Unit type description
Example:
"Covered Parking"
Entity attribute organization UUID (unit type)
Example:
"6fe75622-7de5-11f0-9798-e13a04f5cbb4"
Unit groups belonging to this size-and-type group
Show child attributes
Show child attributes
Previous
Assign a physical lock to a unitRegisters a physical lock assignment to a unit, creating a historical record, note, and unified inbox entry if applicable. If the lock is currently assigned to a different unit, it is unassigned from that unit and reassigned to this one.
Next
⌘I
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"
]
}
'import requests
url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids"
payload = { "sizeAndTypeUnitGroupUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sizeAndTypeUnitGroupUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
})
};
fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sizeAndTypeUnitGroupUuids' => [
'3fa85f64-5717-4562-b3fc-2c963f66afa6',
'3fa85f64-5717-4562-b3fc-2c963f66afa7'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids"
payload := strings.NewReader("{\n \"sizeAndTypeUnitGroupUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sizeAndTypeUnitGroupUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/unitGroups/sizeAndType/get_by_uuids")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sizeAndTypeUnitGroupUuids\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"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"
}
],
"canShowUnitGroupTenantPortal": true
}
]
}
]
