Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Unit Group Rent Roll
Search the full API reference Esc to close

Get Unit Group Rent Roll

Unit groups · REST API reference

Get support
GET/v1/unit-groups/{unit_group_id}/rent-roll
The group's units with who rents each and what they pay, and the group's rent against street.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request 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
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/unit-groups/<UNIT_GROUP_ID>/rent-roll' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

unit_group_idpath · stringrequired

Format: uuid

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "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

dataUnitGroupRentRollResponserequired

A group's units with who rents each and what they pay, and the group's totals.

Show data schema
as_ofstringrequired

The facility's local today; tenure and vacancy are counted up to it.

Format: date

leased_unitsintegerrequired

Units with an active lease.

monthly_rentstringrequired

The rent of every active lease in the group, a month.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

potential_rentstring | null

The 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 | null

The 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
string
Variant 2: null
null
rent_against_streetstring | null

Those 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 | null

Those same units' rent less their street rates: negative when tenants pay under street. Null when no leased unit is priced.

Variant 1: string
string
Variant 2: null
null
street_of_leasedstring | null

The street rates of the leased units that have one, summed. Null when none has.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show street_of_leased schema
string | null

The street rates of the leased units that have one, summed. Null when none has.

Variant 1: string
string
Variant 2: null
null
unit_group_idstringrequired

Format: uuid

unitsUnitGroupRentRollUnit[]
Show units schema
is_rentablebooleanrequired
leaseUnitGroupRentRollLease | null

Null for a unit nobody rents.

Show lease schema
UnitGroupRentRollLease | null

Null for a unit nobody rents.

Variant 1: UnitGroupRentRollLease
idstringrequired

Format: uuid

lease_numberstringrequired
move_in_datestring | null

The move-in date, else the lease's start date.

Format: date

rentstringrequired

What the tenant pays a month now.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

scheduled_effective_datestring | null

When that change takes effect.

Format: date

scheduled_rentstring | null

The rent a change on notice moves the lease to.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

tenant_idstringrequired

Format: uuid

tenant_namestringrequired

The company for a business tenant, else first and last name.

Variant 2: null
null
rate_overriddenboolean

True when that rate is the unit's own, not its group's.

Default: false

statusstringrequired

available, occupied, reserved, overlocked or maintenance.

street_ratestring | null

The street rate the unit quotes; null when unpriced.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show street_rate schema
string | null

The street rate the unit quotes; null when unpriced.

Variant 1: string
string
Variant 2: null
null
unit_idstringrequired

Format: uuid

unit_numberstringrequired
vacant_sincestring | null

The day the unit's last lease ended; null while it is rented or was never rented.

Format: date

Show vacant_since schema
string | null

The day the unit's last lease ended; null while it is rented or was never rented.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll unit groups operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Get Unit Group Rent Roll | Facily Developers