Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Leases
Search the full API reference Esc to close

List Leases

Leases · REST API reference

Get support
GET/v1/facilities/{facility_id}/leases

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>/leases' \
  --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

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

sortquery · string | null

Values: "created_at", "start_date", "next_billing_date", "rate"

orderquery · string

Default: "asc" · Values: "asc", "desc"

statusquery · string | null
tenant_idquery · string | null

Format: uuid

unit_idquery · string | null

Format: uuid

is_autopayquery · boolean | null

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "billing_frequency": "string",
      "created_at": "2026-10-29T12:00:00Z",
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "id": "00000000-0000-4000-8000-000000000001",
      "is_autopay": false,
      "lease_number": "string",
      "ledger_balance": "<VALUE_MATCHING_PATTERN>",
      "next_billing_date": "2026-10-29",
      "original_rate": "<VALUE_MATCHING_PATTERN>",
      "rate": "<VALUE_MATCHING_PATTERN>",
      "start_date": "2026-10-29",
      "status": "string",
      "tenant": {
        "first_name": "string",
        "id": "00000000-0000-4000-8000-000000000001",
        "last_name": "string",
        "tenant_number": "string",
        "email": "string",
        "phone": "string"
      },
      "unit": {
        "id": "00000000-0000-4000-8000-000000000001",
        "unit_number": "string",
        "unit_type_name": "string"
      },
      "updated_at": "2026-10-29T12:00:00Z"
    }
  ],
  "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

dataLeaseResponse[]required
Show data schema
billing_frequencystringrequired

How often rent is charged, for example monthly.

created_atstringrequired

When the lease record was created.

Format: date-time

end_datestring | null

Business date a fixed-term lease ends. Null for a month-to-month lease, which is the usual case.

Format: date

Show end_date schema
string | null

Business date a fixed-term lease ends. Null for a month-to-month lease, which is the usual case.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility this lease belongs to.

Format: uuid

idstringrequired

Unique identifier for this lease.

Format: uuid

is_autopaybooleanrequired

Whether a stored payment method is charged automatically when rent falls due.

lease_numberstringrequired

Operator-facing lease reference, unique within the facility.

ledger_balancestringrequired

Balance on this lease's ledger. Positive means money is owed; negative is a credit.

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

move_in_datestring | null

Business date the tenant took occupancy.

Format: date

Show move_in_date schema
string | null

Business date the tenant took occupancy.

Variant 1: string
string
Variant 2: null
null
move_out_datestring | null

Business date the tenant vacated. Null while the lease is active.

Format: date

Show move_out_date schema
string | null

Business date the tenant vacated. Null while the lease is active.

Variant 1: string
string
Variant 2: null
null
next_billing_datestringrequired

Business date rent is next charged.

Format: date

original_ratestringrequired

Rent agreed at move-in. Comparing it with rate shows the cumulative effect of rate changes.

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

ratestringrequired

Current monthly rent, in the facility's currency. This is what the tenant is billed, and it may differ from the unit's street rate.

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

start_datestringrequired

Business date the lease begins, in the facility's timezone.

Format: date

statusstringrequired

Lifecycle state, for example active, pending, or terminated.

tenantTenantCompactResponserequired

Inline tenant reference. Extended variant adds email/phone.

Show tenant schema
emailstring | null

Primary email address.

Show email schema
string | null

Primary email address.

Variant 1: string
string
Variant 2: null
null
first_namestringrequired

Given name.

idstringrequired

Unique identifier for the tenant.

Format: uuid

last_namestringrequired

Family name.

phonestring | null

Primary telephone number.

Show phone schema
string | null

Primary telephone number.

Variant 1: string
string
Variant 2: null
null
tenant_numberstringrequired

Operator-facing tenant reference, unique within the facility.

termination_datestring | null

Business date the lease was terminated.

Format: date

Show termination_date schema
string | null

Business date the lease was terminated.

Variant 1: string
string
Variant 2: null
null
termination_reasonstring | null

Why the lease ended, for example move-out, transfer, or auction.

Show termination_reason schema
string | null

Why the lease ended, for example move-out, transfer, or auction.

Variant 1: string
string
Variant 2: null
null
unitUnitCompactResponserequired
Show unit schema
idstringrequired

Format: uuid

unit_numberstringrequired
unit_type_namestringrequired
updated_atstringrequired

When the lease record was last modified.

Format: date-time

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 leases operations
Build something that works beautifully.

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

List Leases | Facily Developers