Get units by UUIDs

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": "Segment 1",
    "floorLevel": 0,
    "tierLevel": 2,
    "contents": [
      "Table, Chair, etc."
    ],
    "status": "VACANT",
    "unitType": "UNIT",
    "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",
    "unrentableReasonUuid": "a4201001-0000-4000-8000-000000000002",
    "unrentableReason": "Damaged",
    "unrentableSince": "2024-01-18T09:00:00.000Z",
    "type": "Climate-Controlled",
    "tier": "Premium",
    "amenities": [
      "Climate-Controlled",
      "Digital Lock"
    ],
    "inServiceDate": "2024-01-15T10:30:00.000Z"
  }
]

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

Free-text label of the unit's facility segment — a logical zone within the facility, which gate integrations also use as an access zone. Not the floor, and not parseable into one — see floorLevel.

Example:

"Segment 1"

floorLevel

integer | null

required

Numeric level of the facility floor the unit is on. Zero-based: 0 is the ground floor (the one Monument labels Floor 1), 1 the floor above it, and basement levels are negative. 0 is a real level, so treat only null — the unit is not assigned to a floor — as "no floor". Distinct from floor, which is the free-text facility-segment label and is not parseable into this value.

Example:

0

tierLevel

number | null

required

Tier level of the unit's unit group, one of 0, 1, 2, accepted verbatim by the tier-based unit group write endpoints. 0 is the cheapest tier by convention and 2 the most expensive. Null when the unit has no unit group or its unit group has no tier assigned.

Example:

2

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,

PENDING_MOVE_IN

Example:

"VACANT"

unitType

enum<string>

required

Whether the unit is a storage unit or a parking space. Three similarly named fields all carry the unit-type attribute instead, not this distinction: type above, the unitType on the unit-group sizeAndType response, and the unitTypeUuid filter on GET /units/uuids. There is no filter for this field — read it from this response.

Available options:

UNIT,

PARKING SPACE

Example:

"UNIT"

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"

unrentableReasonUuid

string<uuid> | null

required

Why the unit is unrentable. Null unless the status is UNRENTABLE, and also null on an UNRENTABLE unit whose reason was never recorded.

Example:

"a4201001-0000-4000-8000-000000000002"

unrentableReason

string | null

required

Human-readable form of unrentableReasonUuid

Example:

"Damaged"

unrentableSince

string<date-time> | null

required

When the unit most recently became UNRENTABLE. Usually null unless the status is UNRENTABLE, but units marked unrentable in bulk — by a data import, a data migration, or a facility archive — can be UNRENTABLE with no date recorded. Only the current unrentable period is kept: a status change made through the app clears the value, and a later move back into UNRENTABLE stamps a new one, while a bulk re-import can leave a stale date on a unit that is no longer UNRENTABLE. Earlier unrentable periods are not retained, so this field cannot be used to reconstruct an unavailability history.

Example:

"2024-01-18T09:00:00.000Z"

type

string | null

Description of the unit's unit-type attribute, e.g. Climate-Controlled or Covered Parking — the same attribute catalogue published as unitTypes on the facility response. This returns the base attribute description, while that catalogue returns the organization-level one, so the two can differ where a portfolio has set an override. Not the per-unit amenities list below, and not the storage-unit-versus-parking-space distinction, which is unitType.

Example:

"Climate-Controlled"

tier

string | null

Unit tier description

Example:

"Premium"

amenities

string[] | null

Unit amenities

Example:

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

inServiceDate

string<date-time> | null

Removed in next release

When the unit went into service at the facility. For a unit imported from a previous management system, it is the creation date carried over from that system; for a unit created in Monument, it is the moment it was created. Use this field, not createdAt, to tell whether the unit existed at the facility on a past date.

Example:

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

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": "Segment 1",
    "floorLevel": 0,
    "tierLevel": 2,
    "contents": [
      "Table, Chair, etc."
    ],
    "status": "VACANT",
    "unitType": "UNIT",
    "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",
    "unrentableReasonUuid": "a4201001-0000-4000-8000-000000000002",
    "unrentableReason": "Damaged",
    "unrentableSince": "2024-01-18T09:00:00.000Z",
    "type": "Climate-Controlled",
    "tier": "Premium",
    "amenities": [
      "Climate-Controlled",
      "Digital Lock"
    ],
    "inServiceDate": "2024-01-15T10:30:00.000Z"
  }
]

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

GL Accounts

ECRI

Journal Entries

Ledger Entries

Rent Changes

Payments

Summary

Auctions

Tenants

User Accounts

Units

Unit Groups

Physical Locks

Move Out

Leads

Tasks

People

Lead Source Options

Notes

Promotions

Webhooks

Headers

Path Parameters

Body

Response