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

Get Unit By Number

Units · REST API reference

Get support
GET/v1/facilities/{facility_id}/units/by-number/{unit_number}

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>/units/by-number/<UNIT_NUMBER>' \
  --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 · stringrequired

Format: uuid

unit_numberpath · stringrequired

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "created_at": "2026-10-29T12:00:00Z",
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "id": "00000000-0000-4000-8000-000000000001",
    "is_rentable": false,
    "status": "string",
    "unit_number": "string",
    "unit_type_id": "00000000-0000-4000-8000-000000000001",
    "updated_at": "2026-10-29T12:00:00Z",
    "active_lease": {
      "id": "00000000-0000-4000-8000-000000000001",
      "lease_number": "string",
      "next_billing_date": "2026-10-29",
      "rate": "<VALUE_MATCHING_PATTERN>",
      "start_date": "2026-10-29",
      "status": "string",
      "tenant_id": "00000000-0000-4000-8000-000000000001",
      "tenant_name": "string",
      "unit_number": "string",
      "insurance_plan": {
        "coverage_amount": "<VALUE_MATCHING_PATTERN>",
        "id": "00000000-0000-4000-8000-000000000001",
        "monthly_premium": "<VALUE_MATCHING_PATTERN>",
        "name": "string"
      }
    },
    "delinquency_stage": "string",
    "depth_feet": "<VALUE_MATCHING_PATTERN>",
    "features": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "name": "string",
        "short_code": "string"
      }
    ]
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataUnitResponserequired

Compact unit representation for list endpoints.

Show data schema
active_leaseLeaseCompactResponse | null

The lease currently occupying this unit, or null when it is empty.

Show active_lease schema
LeaseCompactResponse | null

The lease currently occupying this unit, or null when it is empty.

Variant 1: LeaseCompactResponse
idstringrequired

Unique identifier for the lease.

Format: uuid

insurance_planInsurancePlanCompactResponse | null

The protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.

Show insurance_plan schema
InsurancePlanCompactResponse | null

The protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.

Variant 1: InsurancePlanCompactResponse
Variant 2: null
lease_numberstringrequired

Operator-facing lease reference, unique within the facility.

next_billing_datestringrequired

Business date rent is next charged.

Format: date

ratestringrequired

Current monthly rent charged under this lease.

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

start_datestringrequired

Business date the lease began.

Format: date

statusstringrequired

Lifecycle state of the lease.

tenant_idstringrequired

The tenant renting under this lease.

Format: uuid

tenant_namestringrequired

The tenant's display name, denormalized so a listing needs no second call.

unit_numberstringrequired

Label of the unit this lease occupies.

Variant 2: null
null
created_atstringrequired

When the unit record was created.

Format: date-time

delinquency_stagestring | null

How far the occupying tenant has progressed through the facility's delinquency ladder. Null when the unit is empty or the tenant is current.

Show delinquency_stage schema
string | null

How far the occupying tenant has progressed through the facility's delinquency ladder. Null when the unit is empty or the tenant is current.

Variant 1: string
string
Variant 2: null
null
depth_feetstring | null

Interior depth. Expressed in the facility's measurement system.

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

Show depth_feet schema
string | null

Interior depth. Expressed in the facility's measurement system.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility this unit belongs to.

Format: uuid

featuresFeatureCompactResponse[]

Physical characteristics of this unit, such as climate control, drive-up access, or power.

Show features schema
idstringrequired

Format: uuid

namestringrequired
short_codestring | null
Show short_code schema
string | null
Variant 1: string
string
Variant 2: null
null
floorinteger | null

Floor number for a multi-storey building. Ground floor is 1.

Show floor schema
integer | null

Floor number for a multi-storey building. Ground floor is 1.

Variant 1: integer
integer
Variant 2: null
null
height_feetstring | null

Interior height, where the operator records it.

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

Show height_feet schema
string | null

Interior height, where the operator records it.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this unit.

Format: uuid

is_rentablebooleanrequired

Whether the unit may currently be rented. False covers units held back for any reason, including maintenance and owner use.

managedboolean

True when the unit's street rate is set by its group's pricing rules.

Default: false

notesstring | null

Free-text operator notes about the unit itself, not about its occupant.

Show notes schema
string | null

Free-text operator notes about the unit itself, not about its occupant.

Variant 1: string
string
Variant 2: null
null
outside_guardrailsboolean

True when the unit's own rate is below its group's floor or above its ceiling. Allowed, and shown as a warning.

Default: false

rate_overriddenboolean

True when this unit carries its own rate rather than inheriting its group's.

Default: false

square_feetstring | null

Floor area, derived from width and depth rather than stored. Read-only.

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

Show square_feet schema
string | null

Floor area, derived from width and depth rather than stored. Read-only.

Variant 1: string
string
Variant 2: null
null
standard_ratestring | null

Effective street rate to quote, in the facility's currency. Falls back to the unit group's rate when the unit carries no override, and is null when the unit has never been priced.

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

Show standard_rate schema
string | null

Effective street rate to quote, in the facility's currency. Falls back to the unit group's rate when the unit carries no override, and is null when the unit has never been priced.

Variant 1: string
string
Variant 2: null
null
statusstringrequired

Current occupancy state, for example available, occupied, reserved, or unavailable.

tenant_balancestring | null

Balance owed by the occupying tenant. Positive means money is owed.

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

Show tenant_balance schema
string | null

Balance owed by the occupying tenant. Positive means money is owed.

Variant 1: string
string
Variant 2: null
null
unit_groupUnitGroupCompactResponse | null

The unit group this unit belongs to, if any. The group is what normally sets the rate.

Show unit_group schema
UnitGroupCompactResponse | null

The unit group this unit belongs to, if any. The group is what normally sets the rate.

Variant 1: UnitGroupCompactResponse
codestring | null

Short operator-assigned code for the group.

Show code schema
string | null

Short operator-assigned code for the group.

Variant 1: string
Variant 2: null
effective_standard_ratestring | null

The street rate a unit of this group quotes when it has no rate of its own.

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

Show effective_standard_rate schema
string | null

The street rate a unit of this group quotes when it has no rate of its own.

Variant 1: string
Variant 2: null
effective_web_ratestring | null

The online rate a unit of this group quotes when it has no rate of its own.

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

Show effective_web_rate schema
string | null

The online rate a unit of this group quotes when it has no rate of its own.

Variant 1: string
Variant 2: null
idstringrequired

Unique identifier for the unit group.

Format: uuid

managedboolean

True when pricing rules set the group's effective street rate.

Default: false

managed_ratestring | null

Street rate set by pricing rules; null when no rule applies to the group.

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

Show managed_rate schema
string | null

Street rate set by pricing rules; null when no rule applies to the group.

Variant 1: string
Variant 2: null
managed_web_discountstring | null

Percentage points pricing rules add to the group's online discount; null when none applies.

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

Show managed_web_discount schema
string | null

Percentage points pricing rules add to the group's online discount; null when none applies.

Variant 1: string
Variant 2: null
max_ratestring | null

Ceiling: no pricing rule moves the group's street rate above it.

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

Show max_rate schema
string | null

Ceiling: no pricing rule moves the group's street rate above it.

Variant 1: string
Variant 2: null
min_ratestring | null

Floor: no pricing rule moves the group's street rate below it.

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

Show min_rate schema
string | null

Floor: no pricing rule moves the group's street rate below it.

Variant 1: string
Variant 2: null
namestringrequired

Display name of the group.

standard_ratestring | null

Street rate applied to units in this group that carry no override.

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

Show standard_rate schema
string | null

Street rate applied to units in this group that carry no override.

Variant 1: string
Variant 2: null
web_managedboolean

True when a pricing rule adjusts the group's effective online rate.

Default: false

web_ratestring | null

Rate quoted online for units in this group.

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

Show web_rate schema
string | null

Rate quoted online for units in this group.

Variant 1: string
Variant 2: null
Variant 2: null
null
unit_numberstringrequired

The unit's label as posted on the door and printed on the lease. Unique within the facility.

unit_type_idstringrequired

The unit type this unit is classified under, which drives its billing and account coding.

Format: uuid

unit_type_namestring | null

Display name of the unit type, denormalized so listing units needs no second call.

Show unit_type_name schema
string | null

Display name of the unit type, denormalized so listing units needs no second call.

Variant 1: string
string
Variant 2: null
null
updated_atstringrequired

When the unit record was last modified.

Format: date-time

web_managedboolean

True when a pricing rule adjusts the unit's online rate.

Default: false

web_ratestring | null

Rate quoted through online channels, where the operator prices web rentals differently from walk-ins.

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

Show web_rate schema
string | null

Rate quoted through online channels, where the operator prices web rentals differently from walk-ins.

Variant 1: string
string
Variant 2: null
null
width_feetstring | null

Interior width. Expressed in the facility's measurement system.

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

Show width_feet schema
string | null

Interior width. Expressed in the facility's measurement system.

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

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

Get Unit By Number | Facily Developers