/v1/facilities/{facility_id}/access/lockoutsAuthentication
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>/access/lockouts' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"denied_reasons": [
"string"
],
"lease_id": "00000000-0000-4000-8000-000000000001",
"no_open_case": false,
"unit_id": "00000000-0000-4000-8000-000000000001",
"unit_number": "string",
"balance": "<VALUE_MATCHING_PATTERN>",
"case": {
"days_past_due": 0,
"id": "00000000-0000-4000-8000-000000000001",
"opened_on": "2026-10-29",
"state": "string"
},
"denied_since": "2026-10-29T12:00:00Z",
"links": [
{
"link_status": "string",
"provider": "string",
"holds": [
{
"code": "string",
"message": "string"
}
],
"sync_status": "string"
}
],
"manual_hold": {
"reason": "string",
"note": "string",
"placed_at": "2026-10-29T12:00:00Z",
"placed_by": "00000000-0000-4000-8000-000000000001",
"placed_by_name": "string"
},
"since": "2026-10-29T12:00:00Z",
"suspended_at": "2026-10-29T12:00:00Z"
}
],
"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
dataAccessLockoutResponse[]requiredShow data schema
balancestring | nullThe lease's balance; null without permission to read ledgers.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show balance schema
string | nullThe lease's balance; null without permission to read ledgers.
Variant 1: string
stringVariant 2: null
nullcaseAccessOpenCaseResponse | nullThe open delinquency case, if any.
Show case schema
AccessOpenCaseResponse | nullThe open delinquency case, if any.
Variant 1: AccessOpenCaseResponse
days_past_dueintegerrequiredDays past due at the last evaluation.
idstringrequiredThe case.
Format: uuid
opened_onstringrequiredWhen the case opened.
Format: date
statestringrequiredIts delinquency state.
Variant 2: null
nulldenied_reasonsstring[]requiredEvery reason that applies, in this order: auction, lockout_delinquency, lockout_manual, overlock.
Show denied_reasons schema
stringdenied_sincestring | nullWhen the provider confirmed it holds the unit denied.
Format: date-time
Show denied_since schema
string | nullWhen the provider confirmed it holds the unit denied.
Variant 1: string
stringVariant 2: null
nulllease_idstringrequiredThe lease that occupies it.
Format: uuid
linksAccessLockoutLinkResponse[]The unit's link to each provider; empty when no provider has a record of the unit.
Show links schema
holdsAccessCodeResponse[]Work deliberately held, and why, as on the roster. move_in_deferred: the provider holds the unit vacant while its tenant is denied, so it never confirms a denial for it.
Show holds schema
codestringrequiredThe code, for example tenant_unlinked or credential_rejected.
messagestringrequiredWhat the code means, in a sentence to show staff.
link_statusstringrequiredlinked, unlinked or excluded. Only a linked unit is sent to the provider.
providerstringrequiredThe provider, for example kiss.
sync_statusstring | nullsynced, pending, failed, blocked or held, once linked.
Show sync_status schema
string | nullsynced, pending, failed, blocked or held, once linked.
Variant 1: string
stringVariant 2: null
nullmanual_holdAccessManualHoldResponse | nullThe manual hold, if one is placed.
Show manual_hold schema
AccessManualHoldResponse | nullThe manual hold, if one is placed.
Variant 1: AccessManualHoldResponse
notestring | nullWhat they recorded; null without permission to read tenants.
Show note schema
string | nullWhat they recorded; null without permission to read tenants.
Variant 1: string
Variant 2: null
placed_atstring | nullWhen it was placed.
Format: date-time
Show placed_at schema
string | nullWhen it was placed.
Variant 1: string
Variant 2: null
placed_bystring | nullWho placed it.
Format: uuid
Show placed_by schema
string | nullWho placed it.
Variant 1: string
Variant 2: null
placed_by_namestring | nullTheir name.
Show placed_by_name schema
string | nullTheir name.
Variant 1: string
Variant 2: null
reasonstringrequiredviolation, safety or other.
Variant 2: null
nullno_open_casebooleanrequiredTrue when a delinquency lockout or an overlock is on the lease and no delinquency case is open (what restore lifts); never for a hold alone.
sincestring | nullThe earliest start Facily keeps among the reasons.
Format: date-time
Show since schema
string | nullThe earliest start Facily keeps among the reasons.
Variant 1: string
stringVariant 2: null
nullsuspended_atstring | nullWhen the delinquency lockout began.
Format: date-time
Show suspended_at schema
string | nullWhen the delinquency lockout began.
Variant 1: string
stringVariant 2: null
nulltenant_idstring | nullThe tenant.
Format: uuid
Show tenant_id schema
string | nullThe tenant.
Variant 1: string
stringVariant 2: null
nulltenant_namestring | nullTheir name; null without permission to read tenants.
Show tenant_name schema
string | nullTheir name; null without permission to read tenants.
Variant 1: string
stringVariant 2: null
nullunit_idstringrequiredThe unit.
Format: uuid
unit_numberstringrequiredIts number.
metaMetarequiredEnvelope 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