/v1/facilities/{facility_id}/unitsAuthentication
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>/units' \
--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
pagequery · integer | null1-based page number, for a numbered pager. Mutually exclusive with `cursor`.
Minimum: 1
sortquery · string | nullValues: "unit_number", "created_at", "status", "size", "unit_type", "unit_group"
orderquery · stringDefault: "asc" · Values: "asc", "desc"
statusquery · string | nullunit_type_idquery · string | nullFormat: uuid
is_rentablequery · boolean | nullsearchquery · string | nullunit_group_idquery · string | nullFormat: uuid
min_sqftquery · number | string | nullMinimum: 0 · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
max_sqftquery · number | string | nullMinimum: 0 · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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"
},
"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
dataUnitResponse[]requiredShow data schema
active_leaseLeaseCompactResponse | nullThe lease currently occupying this unit, or null when it is empty.
Show active_lease schema
LeaseCompactResponse | nullThe lease currently occupying this unit, or null when it is empty.
Variant 1: LeaseCompactResponse
idstringrequiredUnique identifier for the lease.
Format: uuid
insurance_planInsurancePlanCompactResponse | nullThe protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.
Show insurance_plan schema
InsurancePlanCompactResponse | nullThe 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_numberstringrequiredOperator-facing lease reference, unique within the facility.
next_billing_datestringrequiredBusiness date rent is next charged.
Format: date
ratestringrequiredCurrent monthly rent charged under this lease.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
start_datestringrequiredBusiness date the lease began.
Format: date
statusstringrequiredLifecycle state of the lease.
tenant_idstringrequiredThe tenant renting under this lease.
Format: uuid
tenant_namestringrequiredThe tenant's display name, denormalized so a listing needs no second call.
unit_numberstringrequiredLabel of the unit this lease occupies.
Variant 2: null
nullcreated_atstringrequiredWhen the unit record was created.
Format: date-time
delinquency_stagestring | nullHow 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 | nullHow 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
stringVariant 2: null
nulldepth_feetstring | nullInterior depth. Expressed in the facility's measurement system.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show depth_feet schema
string | nullInterior depth. Expressed in the facility's measurement system.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredThe 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
idstringrequiredFormat: uuid
namestringrequiredshort_codestring | nullShow short_code schema
string | nullVariant 1: string
stringVariant 2: null
nullfloorinteger | nullFloor number for a multi-storey building. Ground floor is 1.
Show floor schema
integer | nullFloor number for a multi-storey building. Ground floor is 1.
Variant 1: integer
integerVariant 2: null
nullheight_feetstring | nullInterior height, where the operator records it.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show height_feet schema
string | nullInterior height, where the operator records it.
Variant 1: string
stringVariant 2: null
nullidstringrequiredUnique identifier for this unit.
Format: uuid
is_rentablebooleanrequiredWhether the unit may currently be rented. False covers units held back for any reason, including maintenance and owner use.
managedbooleanTrue when the unit's street rate is set by its group's pricing rules.
Default: false
notesstring | nullFree-text operator notes about the unit itself, not about its occupant.
Show notes schema
string | nullFree-text operator notes about the unit itself, not about its occupant.
Variant 1: string
stringVariant 2: null
nulloutside_guardrailsbooleanTrue 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_overriddenbooleanTrue when this unit carries its own rate rather than inheriting its group's.
Default: false
square_feetstring | nullFloor area, derived from width and depth rather than stored. Read-only.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show square_feet schema
string | nullFloor area, derived from width and depth rather than stored. Read-only.
Variant 1: string
stringVariant 2: null
nullstandard_ratestring | nullEffective 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 | nullEffective 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
stringVariant 2: null
nullstatusstringrequiredCurrent occupancy state, for example available, occupied, reserved, or unavailable.
tenant_balancestring | nullBalance owed by the occupying tenant. Positive means money is owed.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show tenant_balance schema
string | nullBalance owed by the occupying tenant. Positive means money is owed.
Variant 1: string
stringVariant 2: null
nullunit_groupUnitGroupCompactResponse | nullThe unit group this unit belongs to, if any. The group is what normally sets the rate.
Show unit_group schema
UnitGroupCompactResponse | nullThe unit group this unit belongs to, if any. The group is what normally sets the rate.
Variant 1: UnitGroupCompactResponse
codestring | nullShort operator-assigned code for the group.
Show code schema
string | nullShort operator-assigned code for the group.
Variant 1: string
Variant 2: null
effective_standard_ratestring | nullThe 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 | nullThe 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 | nullThe 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 | nullThe online rate a unit of this group quotes when it has no rate of its own.
Variant 1: string
Variant 2: null
idstringrequiredUnique identifier for the unit group.
Format: uuid
managedbooleanTrue when pricing rules set the group's effective street rate.
Default: false
managed_ratestring | nullStreet rate set by pricing rules; null when no rule applies to the group.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show managed_rate schema
string | nullStreet rate set by pricing rules; null when no rule applies to the group.
Variant 1: string
Variant 2: null
managed_web_discountstring | nullPercentage points pricing rules add to the group's online discount; null when none applies.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show managed_web_discount schema
string | nullPercentage points pricing rules add to the group's online discount; null when none applies.
Variant 1: string
Variant 2: null
max_ratestring | nullCeiling: no pricing rule moves the group's street rate above it.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show max_rate schema
string | nullCeiling: no pricing rule moves the group's street rate above it.
Variant 1: string
Variant 2: null
min_ratestring | nullFloor: no pricing rule moves the group's street rate below it.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show min_rate schema
string | nullFloor: no pricing rule moves the group's street rate below it.
Variant 1: string
Variant 2: null
namestringrequiredDisplay name of the group.
standard_ratestring | nullStreet rate applied to units in this group that carry no override.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show standard_rate schema
string | nullStreet rate applied to units in this group that carry no override.
Variant 1: string
Variant 2: null
web_managedbooleanTrue when a pricing rule adjusts the group's effective online rate.
Default: false
web_ratestring | nullRate quoted online for units in this group.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show web_rate schema
string | nullRate quoted online for units in this group.
Variant 1: string
Variant 2: null
Variant 2: null
nullunit_numberstringrequiredThe unit's label as posted on the door and printed on the lease. Unique within the facility.
unit_type_idstringrequiredThe unit type this unit is classified under, which drives its billing and account coding.
Format: uuid
unit_type_namestring | nullDisplay name of the unit type, denormalized so listing units needs no second call.
Show unit_type_name schema
string | nullDisplay name of the unit type, denormalized so listing units needs no second call.
Variant 1: string
stringVariant 2: null
nullupdated_atstringrequiredWhen the unit record was last modified.
Format: date-time
web_managedbooleanTrue when a pricing rule adjusts the unit's online rate.
Default: false
web_ratestring | nullRate quoted through online channels, where the operator prices web rentals differently from walk-ins.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show web_rate schema
string | nullRate quoted through online channels, where the operator prices web rentals differently from walk-ins.
Variant 1: string
stringVariant 2: null
nullwidth_feetstring | nullInterior width. Expressed in the facility's measurement system.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show width_feet schema
string | nullInterior width. Expressed in the facility's measurement system.
Variant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope 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