/v1/facilities/{facility_id}/rent-rollAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request GET \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/rent-roll' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · string | stringrequiredFormat: uuid
searchquery · string | nullMax length: 100
unit_group_idquery · string | nullFormat: uuid
cursorquery · string | nulllimitquery · integerDefault: 200 · Minimum: 1 · Maximum: 500
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"current_rate": "<VALUE_MATCHING_PATTERN>",
"facility_id": "00000000-0000-4000-8000-000000000001",
"group_label": "string",
"last_rate_change_on": "2026-10-29",
"lease_id": "00000000-0000-4000-8000-000000000001",
"lease_number": "string",
"move_in_date": "2026-10-29",
"rate_cap": "<VALUE_MATCHING_PATTERN>",
"rate_cap_until": "2026-10-29",
"rent_increase_mode": "string",
"scheduled_effective_date": "2026-10-29",
"scheduled_notice_status": "string",
"scheduled_rate": "<VALUE_MATCHING_PATTERN>",
"size": "string",
"street_rate": "<VALUE_MATCHING_PATTERN>",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"tenant_name": "string",
"unit_group_id": "00000000-0000-4000-8000-000000000001",
"unit_id": "00000000-0000-4000-8000-000000000001",
"unit_number": "string"
}
],
"meta": {
"request_id": "string"
},
"pagination": {
"has_more": false,
"limit": 0,
"cursor": "string",
"total_count": 0
},
"metrics": {
"cards": {},
"computed_at": "2026-10-29T12:00:00Z",
"is_stale": false,
"scope": "facility"
}
}application/json
dataRentRollRowResponse[]requiredShow data schema
current_ratestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
facility_idstringrequiredFormat: uuid
group_labelstring | nullrequiredShow group_label schema
string | nullVariant 1: string
stringVariant 2: null
nulllast_rate_change_onstring | nullrequiredFormat: date
Show last_rate_change_on schema
string | nullVariant 1: string
stringVariant 2: null
nulllease_idstringrequiredFormat: uuid
lease_numberstringrequiredmove_in_datestring | nullrequiredFormat: date
Show move_in_date schema
string | nullVariant 1: string
stringVariant 2: null
nullrate_capstring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show rate_cap schema
string | nullVariant 1: string
stringVariant 2: null
nullrate_cap_untilstring | nullrequiredFormat: date
Show rate_cap_until schema
string | nullVariant 1: string
stringVariant 2: null
nullrent_increase_modestringrequiredscheduled_effective_datestring | nullrequiredFormat: date
Show scheduled_effective_date schema
string | nullVariant 1: string
stringVariant 2: null
nullscheduled_notice_statusstring | nullrequiredShow scheduled_notice_status schema
string | nullVariant 1: string
stringVariant 2: null
nullscheduled_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show scheduled_rate schema
string | nullVariant 1: string
stringVariant 2: null
nullsizestring | nullrequiredShow size schema
string | nullVariant 1: string
stringVariant 2: null
nullstreet_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show street_rate schema
string | nullVariant 1: string
stringVariant 2: null
nulltenant_idstringrequiredFormat: uuid
tenant_namestringrequiredunit_group_idstring | nullrequiredFormat: uuid
Show unit_group_id schema
string | nullVariant 1: string
stringVariant 2: null
nullunit_idstringrequiredFormat: uuid
unit_numberstringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequiredmetricsEmbeddedMetrics | nullShow metrics schema
EmbeddedMetrics | nullVariant 1: EmbeddedMetrics
cardsobjectrequiredcomputed_atstring | nullrequiredFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullis_stalebooleanrequiredscopestringrequiredValues: "facility", "portfolio"
Variant 2: null
nullpaginationPaginationBlockrequiredPagination metadata for list responses.
Show pagination schema
cursorstring | nullShow cursor schema
string | nullVariant 1: string
stringVariant 2: null
nullhas_morebooleanrequiredlimitintegerrequiredtotal_countinteger | nullShow total_count schema
integer | nullVariant 1: integer
integerVariant 2: null
null400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired