Get unit UUIDs for a facility

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

Query Parameters

updatedAt.lessOrEqual

string

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

updatedAt.greaterOrEqual

string

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

createdAt.lessOrEqual

string

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

createdAt.greaterOrEqual

string

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

unitStatuses

string[]

required

unitTypeUuid

string

Unit type UUID to filter units by

amenityUuid

string

Amenity UUID to filter units that have this amenity

limit

number

globalFilterFacilityIds

string[]

filters

object

Show child attributes

filters[facilityUuid]

string<uuid>

required

Facility UUID to filter units by

Example:

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

filters[updatedAtLessOrEqual]

string<date-time>

Filter by updatedAt less than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[updatedAtGreaterOrEqual]

string<date-time>

Filter by updatedAt greater than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[createdAtLessOrEqual]

string<date-time>

Filter by createdAt less than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[createdAtGreaterOrEqual]

string<date-time>

Filter by createdAt greater than or equal to this date-time

Example:

"2024-12-29T00:00:24.245Z"

filters[unitStatuses]

enum<string>[]

Array of unit occupancy statuses to filter by. If undefined, null, or empty array, includes units of all statuses.

Available options:

VACANT,

RESERVED,

OCCUPIED,

UNRENTABLE,

OWNER OCCUPIED

Example:

["VACANT", "OCCUPIED"]

filters[unitTypeUuid]

string<uuid>

Unit type UUID to filter units by

Example:

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

filters[amenityUuid]

string<uuid>

Amenity UUID to filter units that have this amenity

Example:

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

Response

200 - application/json

IntegrationAPI

API Reference

Headers

Path Parameters

Query Parameters

Response