/v1/leases/{lease_id}Authentication
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/leases/<LEASE_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
lease_idpath · stringrequiredFormat: uuid
Responses
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"
}
}application/json
dataLeaseDetailResponserequiredFull lease detail with all related data.
Show data schema
access_grantsAccessGrantCompactResponse[]Show access_grants schema
access_levelstringrequiredgate_codestring | nullShow gate_code schema
string | nullVariant 1: string
stringVariant 2: null
nullgranted_atstringrequiredFormat: date-time
idstringrequiredFormat: uuid
manual_hold_atstring | nullFormat: date-time
Show manual_hold_at schema
string | nullVariant 1: string
stringVariant 2: null
nullmanual_hold_bystring | nullFormat: uuid
Show manual_hold_by schema
string | nullVariant 1: string
stringVariant 2: null
nullmanual_hold_notestring | nullShow manual_hold_note schema
string | nullVariant 1: string
stringVariant 2: null
nullmanual_hold_reasonstring | nullShow manual_hold_reason schema
string | nullVariant 1: string
stringVariant 2: null
nullstatusstringrequiredsuspended_atstring | nullFormat: date-time
Show suspended_at schema
string | nullVariant 1: string
stringVariant 2: null
nullsuspension_reasonstring | nullShow suspension_reason schema
string | nullVariant 1: string
stringVariant 2: null
nullsync_statusstringrequiredtenant_contact_idstring | nullFormat: uuid
Show tenant_contact_id schema
string | nullVariant 1: string
stringVariant 2: null
nullautopayAutopayEnrollmentResponse | nullShow autopay schema
AutopayEnrollmentResponse | nullVariant 1: AutopayEnrollmentResponse
charge_day_offsetintegerrequiredconsecutive_failuresintegerrequiredconsent_versionstring | nullShow consent_version schema
string | nullVariant 1: string
Variant 2: null
consented_atstring | nullFormat: date-time
Show consented_at schema
string | nullVariant 1: string
Variant 2: null
enrolled_atstringrequiredFormat: date-time
idstringrequiredFormat: uuid
is_activebooleanrequiredlast_charge_atstring | nullFormat: date-time
Show last_charge_at schema
string | nullVariant 1: string
Variant 2: null
last_charge_statusstring | nullShow last_charge_status schema
string | nullVariant 1: string
Variant 2: null
lease_idstringrequiredFormat: uuid
max_amountstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show max_amount schema
string | nullVariant 1: string
Variant 2: null
next_attempt_onstring | nullFormat: date
Show next_attempt_on schema
string | nullVariant 1: string
Variant 2: null
payment_method_idstringrequiredFormat: uuid
suspended_atstring | nullFormat: date-time
Show suspended_at schema
string | nullVariant 1: string
Variant 2: null
suspension_reasonstring | nullShow suspension_reason schema
string | nullVariant 1: string
Variant 2: null
tenant_idstringrequiredFormat: uuid
Variant 2: null
nullbilling_frequencystringrequiredHow often rent is charged, for example monthly.
created_atstringrequiredWhen the lease record was created.
Format: date-time
delinquencyLeaseDelinquencyCompactResponse | nullShow delinquency schema
LeaseDelinquencyCompactResponse | nullVariant 1: LeaseDelinquencyCompactResponse
balancestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
current_statestringrequireddays_past_dueintegerrequiredlast_event_atstring | nullFormat: date-time
Show last_event_at schema
string | nullVariant 1: string
Variant 2: null
next_stagestring | nullShow next_stage schema
string | nullVariant 1: string
Variant 2: null
next_stage_datestring | nullFormat: date
Show next_stage_date schema
string | nullVariant 1: string
Variant 2: null
Variant 2: null
nullend_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
feesLeaseFeeCompactResponse[]Show fees schema
amountstring | nullPer charge; null for a percentage fee.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
string | nullPer charge; null for a percentage fee.
Variant 1: string
stringVariant 2: null
nullcodestringrequiredfee_rule_idstringrequiredFormat: uuid
fee_typestringrequiredfrequencystringrequiredidstringrequiredFormat: uuid
kindstringrequirednamestringrequiredpercentagestring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show percentage schema
string | nullVariant 1: string
stringVariant 2: null
nullrequiredbooleanrequiredstarts_onstringrequiredFormat: date
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*$
rate_schedulesRateScheduleResponse[]Show rate_schedules schema
applied_atstring | nullWhen the change was actually applied to the lease.
Format: date-time
Show applied_at schema
string | nullWhen the change was actually applied to the lease.
Variant 1: string
stringVariant 2: null
nullbatch_idstring | nullThe rent raise this change belongs to, when it came from one.
Format: uuid
Show batch_id schema
string | nullThe rent raise this change belongs to, when it came from one.
Variant 1: string
stringVariant 2: null
nullcreated_atstringrequiredWhen the rate change was scheduled.
Format: date-time
effective_datestringrequiredBusiness date the new rent takes effect. Billing on or after this date uses new_rate.
Format: date
held_reasonstring | nullnotice_late or notice_undelivered when billing held the change at its effective date.
Show held_reason schema
string | nullnotice_late or notice_undelivered when billing held the change at its effective date.
Variant 1: string
stringVariant 2: null
nullidstringrequiredUnique identifier for this rate change.
Format: uuid
kindstringincrease (needed an advance notice and passed the raise guardrails) or adjustment (a decrease or a backdated correction).
Default: "increase"
lease_idstringrequiredThe lease whose rent is changing.
Format: uuid
new_ratestringrequiredRent after the change.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
notice_attemptsintegerFailed attempts to send the notice; the third makes it undeliverable.
Default: 0
notice_channelstring | nullemail, sms or manual.
Show notice_channel schema
string | nullemail, sms or manual.
Variant 1: string
stringVariant 2: null
nullnotice_notestring | nullHow staff delivered the notice outside Facily, when recorded.
Show notice_note schema
string | nullHow staff delivered the notice outside Facily, when recorded.
Variant 1: string
stringVariant 2: null
nullnotice_required_daysintegerrequiredHow many days of advance notice the tenant must be given before the change may take effect.
notice_sent_atstring | nullWhen notice of the change was sent to the tenant. Null when notice is still outstanding.
Format: date-time
Show notice_sent_at schema
string | nullWhen notice of the change was sent to the tenant. Null when notice is still outstanding.
Variant 1: string
stringVariant 2: null
nullnotice_statusstringpending, sending, sent, undeliverable, manual, imported, not_required or legacy. Billing applies an increase only when its notice was given in time.
Default: "pending"
previous_ratestringrequiredRent before the change.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
reasonstring | nullWhy the rent is changing, for example a scheduled increase or a negotiated adjustment.
Show reason schema
string | nullWhy the rent is changing, for example a scheduled increase or a negotiated adjustment.
Variant 1: string
stringVariant 2: null
nullstatusstringrequiredWhere the change stands: scheduled, applied, cancelled, replaced or held.
recent_ledger_entriesLedgerEntryCompactResponse[]Show recent_ledger_entries schema
amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
created_atstringrequiredFormat: date-time
descriptionstringrequireddiscount_amountstringDefault: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
due_datestring | nullFormat: date
Show due_date schema
string | nullVariant 1: string
stringVariant 2: null
nulleffective_datestringrequiredFormat: date
entry_typestringrequiredidstringrequiredFormat: uuid
invoice_numberstring | nullShow invoice_number schema
string | nullVariant 1: string
stringVariant 2: null
nullrunning_balancestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
sourcestring | nullShow source schema
string | nullVariant 1: string
stringVariant 2: null
nullsubtotalstringDefault: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax_amountstringDefault: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
voided_entry_idstring | nullFormat: uuid
Show voided_entry_id schema
string | nullVariant 1: string
stringVariant 2: null
nullrecent_paymentsPaymentCompactResponse[]Show recent_payments schema
amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
failed_atstring | nullFormat: date-time
Show failed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullidstringrequiredFormat: uuid
method_typestringrequiredpaid_atstring | nullFormat: date-time
Show paid_at schema
string | nullVariant 1: string
stringVariant 2: null
nullpayment_numberstringrequiredsourcestringrequiredstatusstringrequiredstart_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_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