Skip to main content
GET
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
rentalRecords
/
uuids
Get rental records UUIDs from Facility
curl --request GET \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/uuids \
  --header 'x-api-key: <x-api-key>'
[
  "<string>"
]

Documentation Index

Fetch the complete documentation index at: https://api.monument.io/llms.txt

Use this file to discover all available pages before exploring further.

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

Query Parameters

​
updatedAt.lessOrEqual
string

Filter facilities with updatedAt less than or equal to this date-time

​
updatedAt.greaterOrEqual
string

Filter facilities with updatedAt greater than or equal to this date-time

​
createdAt.lessOrEqual
string

Filter facilities with createdAt less than or equal to this date-time

​
createdAt.greaterOrEqual
string

Filter facilities with createdAt greater than or equal to this date-time

​
rentalRecordStatus
enum<string>
Available options:
WAIT_LIST,
AGREEMENT_SENT,
PENDING_MOVE_IN,
MOVED_IN,
PENDING_MOVE_OUT,
MOVED_OUT,
CANCELED_RESERVATION
​
amenityUuids
string[]
​
itemTypeUuids
string[]
​
startRentDate.greaterOrEqual
string

Filter by move-in date (>=), in facility timezone. Format: ISO 8601 date-time

​
startRentDate.lessOrEqual
string

Filter by move-in date (<=), in facility timezone. Format: ISO 8601 date-time

​
endRentDate.greaterOrEqual
string

Filter by move-out date (>=), in facility timezone. Format: ISO 8601 date-time

​
endRentDate.lessOrEqual
string

Filter by move-out date (<=), in facility timezone. Format: ISO 8601 date-time

​
delinquent
boolean

Response

200 - application/json

Array of unit rental records UUIDs from the given facilityUuid, most recently updated first, empty if none are found.