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

Get Lease

Leases · REST API reference

Get support
GET/v1/leases/{lease_id}

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

lease_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": {
    "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

dataLeaseDetailResponserequired

Full lease detail with all related data.

Show data schema
access_grantsAccessGrantCompactResponse[]
Show access_grants schema
access_levelstringrequired
gate_codestring | null
Show gate_code schema
string | null
Variant 1: string
string
Variant 2: null
null
granted_atstringrequired

Format: date-time

idstringrequired

Format: uuid

manual_hold_atstring | null

Format: date-time

Show manual_hold_at schema
string | null
Variant 1: string
string
Variant 2: null
null
manual_hold_bystring | null

Format: uuid

Show manual_hold_by schema
string | null
Variant 1: string
string
Variant 2: null
null
manual_hold_notestring | null
Show manual_hold_note schema
string | null
Variant 1: string
string
Variant 2: null
null
manual_hold_reasonstring | null
Show manual_hold_reason schema
string | null
Variant 1: string
string
Variant 2: null
null
statusstringrequired
suspended_atstring | null

Format: date-time

Show suspended_at schema
string | null
Variant 1: string
string
Variant 2: null
null
suspension_reasonstring | null
Show suspension_reason schema
string | null
Variant 1: string
string
Variant 2: null
null
sync_statusstringrequired
tenant_contact_idstring | null

Format: uuid

Show tenant_contact_id schema
string | null
Variant 1: string
string
Variant 2: null
null
autopayAutopayEnrollmentResponse | null
Show autopay schema
AutopayEnrollmentResponse | null
Variant 1: AutopayEnrollmentResponse
charge_day_offsetintegerrequired
consecutive_failuresintegerrequired
consent_versionstring | null
Show consent_version schema
string | null
Variant 1: string
Variant 2: null
consented_atstring | null

Format: date-time

Show consented_at schema
string | null
Variant 1: string
Variant 2: null
enrolled_atstringrequired

Format: date-time

idstringrequired

Format: uuid

is_activebooleanrequired
last_charge_atstring | null

Format: date-time

Show last_charge_at schema
string | null
Variant 1: string
Variant 2: null
last_charge_statusstring | null
Show last_charge_status schema
string | null
Variant 1: string
Variant 2: null
lease_idstringrequired

Format: uuid

max_amountstring | null

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

Show max_amount schema
string | null
Variant 1: string
Variant 2: null
next_attempt_onstring | null

Format: date

Show next_attempt_on schema
string | null
Variant 1: string
Variant 2: null
payment_method_idstringrequired

Format: uuid

suspended_atstring | null

Format: date-time

Show suspended_at schema
string | null
Variant 1: string
Variant 2: null
suspension_reasonstring | null
Show suspension_reason schema
string | null
Variant 1: string
Variant 2: null
tenant_idstringrequired

Format: uuid

Variant 2: null
null
billing_frequencystringrequired

How often rent is charged, for example monthly.

created_atstringrequired

When the lease record was created.

Format: date-time

delinquencyLeaseDelinquencyCompactResponse | null
Show delinquency schema
LeaseDelinquencyCompactResponse | null
Variant 1: LeaseDelinquencyCompactResponse
balancestringrequired

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

current_statestringrequired
days_past_dueintegerrequired
last_event_atstring | null

Format: date-time

Show last_event_at schema
string | null
Variant 1: string
Variant 2: null
next_stagestring | null
Show next_stage schema
string | null
Variant 1: string
Variant 2: null
next_stage_datestring | null

Format: date

Show next_stage_date schema
string | null
Variant 1: string
Variant 2: null
Variant 2: null
null
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

feesLeaseFeeCompactResponse[]
Show fees schema
amountstring | null

Per charge; null for a percentage fee.

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

Show amount schema
string | null

Per charge; null for a percentage fee.

Variant 1: string
string
Variant 2: null
null
codestringrequired
fee_rule_idstringrequired

Format: uuid

fee_typestringrequired
frequencystringrequired
idstringrequired

Format: uuid

kindstringrequired
namestringrequired
percentagestring | null

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

Show percentage schema
string | null
Variant 1: string
string
Variant 2: null
null
requiredbooleanrequired
starts_onstringrequired

Format: date

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*$

rate_schedulesRateScheduleResponse[]
Show rate_schedules schema
applied_atstring | null

When the change was actually applied to the lease.

Format: date-time

Show applied_at schema
string | null

When the change was actually applied to the lease.

Variant 1: string
string
Variant 2: null
null
batch_idstring | null

The rent raise this change belongs to, when it came from one.

Format: uuid

Show batch_id schema
string | null

The rent raise this change belongs to, when it came from one.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the rate change was scheduled.

Format: date-time

effective_datestringrequired

Business date the new rent takes effect. Billing on or after this date uses new_rate.

Format: date

held_reasonstring | null

notice_late or notice_undelivered when billing held the change at its effective date.

Show held_reason schema
string | null

notice_late or notice_undelivered when billing held the change at its effective date.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this rate change.

Format: uuid

kindstring

increase (needed an advance notice and passed the raise guardrails) or adjustment (a decrease or a backdated correction).

Default: "increase"

lease_idstringrequired

The lease whose rent is changing.

Format: uuid

new_ratestringrequired

Rent after the change.

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

notice_attemptsinteger

Failed attempts to send the notice; the third makes it undeliverable.

Default: 0

notice_channelstring | null

email, sms or manual.

Show notice_channel schema
string | null

email, sms or manual.

Variant 1: string
string
Variant 2: null
null
notice_notestring | null

How staff delivered the notice outside Facily, when recorded.

Show notice_note schema
string | null

How staff delivered the notice outside Facily, when recorded.

Variant 1: string
string
Variant 2: null
null
notice_required_daysintegerrequired

How many days of advance notice the tenant must be given before the change may take effect.

notice_sent_atstring | null

When notice of the change was sent to the tenant. Null when notice is still outstanding.

Format: date-time

Show notice_sent_at schema
string | null

When notice of the change was sent to the tenant. Null when notice is still outstanding.

Variant 1: string
string
Variant 2: null
null
notice_statusstring

pending, sending, sent, undeliverable, manual, imported, not_required or legacy. Billing applies an increase only when its notice was given in time.

Default: "pending"

previous_ratestringrequired

Rent before the change.

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

reasonstring | null

Why the rent is changing, for example a scheduled increase or a negotiated adjustment.

Show reason schema
string | null

Why the rent is changing, for example a scheduled increase or a negotiated adjustment.

Variant 1: string
string
Variant 2: null
null
statusstringrequired

Where the change stands: scheduled, applied, cancelled, replaced or held.

recent_ledger_entriesLedgerEntryCompactResponse[]
Show recent_ledger_entries schema
amountstringrequired

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

created_atstringrequired

Format: date-time

descriptionstringrequired
discount_amountstring

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

due_datestring | null

Format: date

Show due_date schema
string | null
Variant 1: string
string
Variant 2: null
null
effective_datestringrequired

Format: date

entry_typestringrequired
idstringrequired

Format: uuid

invoice_numberstring | null
Show invoice_number schema
string | null
Variant 1: string
string
Variant 2: null
null
running_balancestringrequired

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

sourcestring | null
Show source schema
string | null
Variant 1: string
string
Variant 2: null
null
subtotalstring

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

tax_amountstring

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

voided_entry_idstring | null

Format: uuid

Show voided_entry_id schema
string | null
Variant 1: string
string
Variant 2: null
null
recent_paymentsPaymentCompactResponse[]
Show recent_payments schema
amountstringrequired

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

failed_atstring | null

Format: date-time

Show failed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
idstringrequired

Format: uuid

method_typestringrequired
paid_atstring | null

Format: date-time

Show paid_at schema
string | null
Variant 1: string
string
Variant 2: null
null
payment_numberstringrequired
sourcestringrequired
statusstringrequired
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
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

Get Lease | Facily Developers