/v1/unit-groups/{unit_group_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/unit-groups/<UNIT_GROUP_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
unit_group_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"as_of": "2026-10-29",
"leased_units": 0,
"monthly_rent": "<VALUE_MATCHING_PATTERN>",
"unit_group_id": "00000000-0000-4000-8000-000000000001",
"potential_rent": "<VALUE_MATCHING_PATTERN>",
"rent_against_street": "<VALUE_MATCHING_PATTERN>",
"street_of_leased": "<VALUE_MATCHING_PATTERN>",
"units": [
{
"is_rentable": false,
"status": "string",
"unit_id": "00000000-0000-4000-8000-000000000001",
"unit_number": "string",
"lease": {
"id": "00000000-0000-4000-8000-000000000001",
"lease_number": "string",
"rent": "<VALUE_MATCHING_PATTERN>",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"tenant_name": "string",
"move_in_date": "2026-10-29",
"scheduled_effective_date": "2026-10-29",
"scheduled_rent": "<VALUE_MATCHING_PATTERN>"
},
"rate_overridden": false,
"street_rate": "<VALUE_MATCHING_PATTERN>",
"vacant_since": "2026-10-29"
}
]
},
"meta": {
"request_id": "string"
}
}application/json
dataUnitGroupRentRollResponserequiredA group's units with who rents each and what they pay, and the group's totals.
Show data schema
as_ofstringrequiredThe facility's local today; tenure and vacancy are counted up to it.
Format: date
leased_unitsintegerrequiredUnits with an active lease.
monthly_rentstringrequiredThe rent of every active lease in the group, a month.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
potential_rentstring | nullThe group fully rented at street: every leased unit and every rentable vacant one at its street rate. Null when none of them is priced.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show potential_rent schema
string | nullThe group fully rented at street: every leased unit and every rentable vacant one at its street rate. Null when none of them is priced.
Variant 1: string
stringVariant 2: null
nullrent_against_streetstring | nullThose same units' rent less their street rates: negative when tenants pay under street. Null when no leased unit is priced.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show rent_against_street schema
string | nullThose same units' rent less their street rates: negative when tenants pay under street. Null when no leased unit is priced.
Variant 1: string
stringVariant 2: null
nullstreet_of_leasedstring | nullThe street rates of the leased units that have one, summed. Null when none has.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show street_of_leased schema
string | nullThe street rates of the leased units that have one, summed. Null when none has.
Variant 1: string
stringVariant 2: null
nullunit_group_idstringrequiredFormat: uuid
unitsUnitGroupRentRollUnit[]Show units schema
is_rentablebooleanrequiredleaseUnitGroupRentRollLease | nullNull for a unit nobody rents.
Show lease schema
UnitGroupRentRollLease | nullNull for a unit nobody rents.
Variant 1: UnitGroupRentRollLease
idstringrequiredFormat: uuid
lease_numberstringrequiredmove_in_datestring | nullThe move-in date, else the lease's start date.
Format: date
rentstringrequiredWhat the tenant pays a month now.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
scheduled_effective_datestring | nullWhen that change takes effect.
Format: date
scheduled_rentstring | nullThe rent a change on notice moves the lease to.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tenant_idstringrequiredFormat: uuid
tenant_namestringrequiredThe company for a business tenant, else first and last name.
Variant 2: null
nullrate_overriddenbooleanTrue when that rate is the unit's own, not its group's.
Default: false
statusstringrequiredavailable, occupied, reserved, overlocked or maintenance.
street_ratestring | nullThe street rate the unit quotes; null when unpriced.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show street_rate schema
string | nullThe street rate the unit quotes; null when unpriced.
Variant 1: string
stringVariant 2: null
nullunit_idstringrequiredFormat: uuid
unit_numberstringrequiredvacant_sincestring | nullThe day the unit's last lease ended; null while it is rented or was never rented.
Format: date
Show vacant_since schema
string | nullThe day the unit's last lease ended; null while it is rented or was never rented.
Variant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation 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