Skip to main content
GET
List facility transfer UUIDs

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 transfers with updatedAt less than or equal to this date-time. Interpreted as UTC: a date without a time means midnight UTC, not midnight at the facility.

updatedAt.greaterOrEqual
string

Filter transfers with updatedAt greater than or equal to this date-time. Interpreted as UTC: a date without a time means midnight UTC, not midnight at the facility.

createdAt.lessOrEqual
string

Filter transfers with createdAt less than or equal to this date-time. Interpreted as UTC: a date without a time means midnight UTC, not midnight at the facility.

createdAt.greaterOrEqual
string

Filter transfers with createdAt greater than or equal to this date-time. Interpreted as UTC: a date without a time means midnight UTC, not midnight at the facility.

status
enum<string>

Filter to transfers in this status. Transfers in every status are returned when omitted. Scheduled while the transfer is pending, Completed once the tenant has been moved into the new unit, Canceled when the transfer was called off.

Available options:
Scheduled,
Canceled,
Completed

Response

200 - application/json

Array of transfer UUIDs, most recently updated first, empty if none are found