Get units by UUIDs - Monument Public API

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

units

get_by_uuids

Get units by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/units/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "unitUuids": [
    "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}/units/get_by_uuids"

payload = { "unitUuids": ["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({
    unitUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/units/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}/units/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([
    'unitUuids' => [
        '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}/units/get_by_uuids"

	payload := strings.NewReader("{\n  \"unitUuids\": [\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}/units/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"unitUuids\": [\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}/units/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  \"unitUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "unitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "facilityUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "unitNumber": "A101",
    "floor": "Floor 1",
    "contents": [
      "Table, Chair, etc."
    ],
    "status": "VACANT",
    "currentTenantUuid": "5a6b7c8d-9e0f-1a2b-3c4d-5e6f7a8b9c0d",
    "currentRentalRecordUuid": "6b7c8d9e-0f1a-2b3c-4d5e-6f7a8b9c0d1e",
    "unitGroupUuid": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "currentStreetRate": 15000,
    "currentWebRate": 10000,
    "width": 10.5,
    "height": 8,
    "depth": 10,
    "monthlyRentAmount": 12500,
    "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

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

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"

floor

string

required

Floor specification

Example:

"Floor 1"

contents

string[] | null

required

Unit contents

Example:

["Table, Chair, etc."]

status

enum<string>

required

Unit occupancy status

Available options:

VACANT,

RESERVED,

OCCUPIED,

UNRENTABLE,

OWNER OCCUPIED,

PENDING_SIGNATURE

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"

currentStreetRate

number | null

required

Unit current street rate in pennies

Example:

15000

currentWebRate

number | null

required

Unit current web rate in pennies

Example:

10000

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 in pennies

Example:

12500

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"]

Execute MORA for a unitExecutes MORA for a unit rental record, causing the rent to be instantly adjusted to the new rent amount.

Get units by UUIDs

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/units/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "unitUuids": [
    "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}/units/get_by_uuids"

payload = { "unitUuids": ["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({
    unitUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/units/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}/units/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([
    'unitUuids' => [
        '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}/units/get_by_uuids"

	payload := strings.NewReader("{\n  \"unitUuids\": [\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}/units/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"unitUuids\": [\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}/units/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  \"unitUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "unitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "facilityUuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "unitNumber": "A101",
    "floor": "Floor 1",
    "contents": [
      "Table, Chair, etc."
    ],
    "status": "VACANT",
    "currentTenantUuid": "5a6b7c8d-9e0f-1a2b-3c4d-5e6f7a8b9c0d",
    "currentRentalRecordUuid": "6b7c8d9e-0f1a-2b3c-4d5e-6f7a8b9c0d1e",
    "unitGroupUuid": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "currentStreetRate": 15000,
    "currentWebRate": 10000,
    "width": 10.5,
    "height": 8,
    "depth": 10,
    "monthlyRentAmount": 12500,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T15:45:00.000Z",
    "type": "Climate-Controlled",
    "tier": "Premium",
    "amenities": [
      "Climate-Controlled",
      "Digital Lock"
    ]
  }
]