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

Get Rent Roll

Reports · REST API reference

Get support
GET/v1/facilities/{facility_id}/rent-roll

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/facilities/<FACILITY_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

facility_idpath · string | stringrequired

Format: uuid

searchquery · string | null

Max length: 100

unit_group_idquery · string | null

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 200 · Minimum: 1 · Maximum: 500

Responses

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

200Successful Response
JSON · generated example
{
  "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[]required
Show data schema
current_ratestringrequired

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

facility_idstringrequired

Format: uuid

group_labelstring | nullrequired
Show group_label schema
string | null
Variant 1: string
string
Variant 2: null
null
last_rate_change_onstring | nullrequired

Format: date

Show last_rate_change_on schema
string | null
Variant 1: string
string
Variant 2: null
null
lease_idstringrequired

Format: uuid

lease_numberstringrequired
move_in_datestring | nullrequired

Format: date

Show move_in_date schema
string | null
Variant 1: string
string
Variant 2: null
null
rate_capstring | nullrequired

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

Show rate_cap schema
string | null
Variant 1: string
string
Variant 2: null
null
rate_cap_untilstring | nullrequired

Format: date

Show rate_cap_until schema
string | null
Variant 1: string
string
Variant 2: null
null
rent_increase_modestringrequired
scheduled_effective_datestring | nullrequired

Format: date

Show scheduled_effective_date schema
string | null
Variant 1: string
string
Variant 2: null
null
scheduled_notice_statusstring | nullrequired
Show scheduled_notice_status schema
string | null
Variant 1: string
string
Variant 2: null
null
scheduled_ratestring | nullrequired

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

Show scheduled_rate schema
string | null
Variant 1: string
string
Variant 2: null
null
sizestring | nullrequired
Show size schema
string | null
Variant 1: string
string
Variant 2: null
null
street_ratestring | nullrequired

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

Show street_rate schema
string | null
Variant 1: string
string
Variant 2: null
null
tenant_idstringrequired

Format: uuid

tenant_namestringrequired
unit_group_idstring | nullrequired

Format: uuid

Show unit_group_id schema
string | null
Variant 1: string
string
Variant 2: null
null
unit_idstringrequired

Format: uuid

unit_numberstringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
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 reports operations
Build something that works beautifully.

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

Get Rent Roll | Facily Developers