/v1/facilities/{facility_id}/leasesAuthentication
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>/leases' \
--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
cursorquery · string | nulllimitquery · integerDefault: 50 · Minimum: 1 · Maximum: 200
sortquery · string | nullValues: "created_at", "start_date", "next_billing_date", "rate"
orderquery · stringDefault: "asc" · Values: "asc", "desc"
statusquery · string | nulltenant_idquery · string | nullFormat: uuid
unit_idquery · string | nullFormat: uuid
is_autopayquery · boolean | nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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[]requiredShow data schema
billing_frequencystringrequiredHow often rent is charged, for example monthly.
created_atstringrequiredWhen the lease record was created.
Format: date-time
end_datestring | nullBusiness 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 | nullBusiness date a fixed-term lease ends. Null for a month-to-month lease, which is the usual case.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredThe facility this lease belongs to.
Format: uuid
idstringrequiredUnique identifier for this lease.
Format: uuid
is_autopaybooleanrequiredWhether a stored payment method is charged automatically when rent falls due.
lease_numberstringrequiredOperator-facing lease reference, unique within the facility.
ledger_balancestringrequiredBalance on this lease's ledger. Positive means money is owed; negative is a credit.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
move_in_datestring | nullBusiness date the tenant took occupancy.
Format: date
Show move_in_date schema
string | nullBusiness date the tenant took occupancy.
Variant 1: string
stringVariant 2: null
nullmove_out_datestring | nullBusiness date the tenant vacated. Null while the lease is active.
Format: date
Show move_out_date schema
string | nullBusiness date the tenant vacated. Null while the lease is active.
Variant 1: string
stringVariant 2: null
nullnext_billing_datestringrequiredBusiness date rent is next charged.
Format: date
original_ratestringrequiredRent agreed at move-in. Comparing it with rate shows the cumulative effect of rate changes.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
ratestringrequiredCurrent 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_datestringrequiredBusiness date the lease begins, in the facility's timezone.
Format: date
statusstringrequiredLifecycle state, for example active, pending, or terminated.
tenantTenantCompactResponserequiredInline tenant reference. Extended variant adds email/phone.
Show tenant schema
emailstring | nullPrimary email address.
Show email schema
string | nullPrimary email address.
Variant 1: string
stringVariant 2: null
nullfirst_namestringrequiredGiven name.
idstringrequiredUnique identifier for the tenant.
Format: uuid
last_namestringrequiredFamily name.
phonestring | nullPrimary telephone number.
Show phone schema
string | nullPrimary telephone number.
Variant 1: string
stringVariant 2: null
nulltenant_numberstringrequiredOperator-facing tenant reference, unique within the facility.
termination_datestring | nullBusiness date the lease was terminated.
Format: date
Show termination_date schema
string | nullBusiness date the lease was terminated.
Variant 1: string
stringVariant 2: null
nulltermination_reasonstring | nullWhy the lease ended, for example move-out, transfer, or auction.
Show termination_reason schema
string | nullWhy the lease ended, for example move-out, transfer, or auction.
Variant 1: string
stringVariant 2: null
nullunitUnitCompactResponserequiredShow unit schema
idstringrequiredFormat: uuid
unit_numberstringrequiredunit_type_namestringrequiredupdated_atstringrequiredWhen the lease record was last modified.
Format: date-time
metaMetarequiredEnvelope 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