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

List Unit Leases

Units · REST API reference

Get support
GET/v1/units/{unit_id}/leases
Every lease the unit has had, active and ended, newest first (keyset `(start_date, 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/units/<UNIT_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

unit_idpath · stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "lease_number": "string",
      "rate": "<VALUE_MATCHING_PATTERN>",
      "start_date": "2026-10-29",
      "status": "string",
      "tenant_id": "00000000-0000-4000-8000-000000000001",
      "tenant_name": "string",
      "end_date": "2026-10-29",
      "move_in_date": "2026-10-29",
      "move_out_date": "2026-10-29",
      "termination_date": "2026-10-29",
      "termination_reason": "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

dataUnitLeaseHistoryResponse[]required
Show data schema
end_datestring | null

Business date the lease ended; null while it is open.

Format: date

Show end_date schema
string | null

Business date the lease ended; null while it is open.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for the lease.

Format: uuid

lease_numberstringrequired

Operator-facing lease reference, unique within the facility.

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 occupied.

Format: date

Show move_out_date schema
string | null

Business date the tenant vacated; null while occupied.

Variant 1: string
string
Variant 2: null
null
ratestringrequired

Monthly rent under this lease: current for an active lease, final for an ended one.

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

start_datestringrequired

Business date the lease began.

Format: date

statusstringrequired

Lifecycle state of the lease, for example active or terminated.

tenant_idstringrequired

The tenant who rented the unit under this lease.

Format: uuid

tenant_namestringrequired

The tenant's display name, denormalized so the history needs no second call.

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 was terminated, where recorded.

Show termination_reason schema
string | null

Why the lease was terminated, where recorded.

Variant 1: string
string
Variant 2: null
null
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 units operations
Build something that works beautifully.

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

List Unit Leases | Facily Developers