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

List Access Lockouts

Access control · REST API reference

Get support
GET/v1/facilities/{facility_id}/access/lockouts
Every denied unit, with every reason and the open case if any. `no_open_case` is true 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.

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>/access/lockouts' \
  --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

Responses

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

200Successful Response
JSON · generated example
{
  "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[]required
Show data schema
balancestring | null

The lease's balance; null without permission to read ledgers.

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

Show balance schema
string | null

The lease's balance; null without permission to read ledgers.

Variant 1: string
string
Variant 2: null
null
caseAccessOpenCaseResponse | null

The open delinquency case, if any.

Show case schema
AccessOpenCaseResponse | null

The open delinquency case, if any.

Variant 1: AccessOpenCaseResponse
days_past_dueintegerrequired

Days past due at the last evaluation.

idstringrequired

The case.

Format: uuid

opened_onstringrequired

When the case opened.

Format: date

statestringrequired

Its delinquency state.

Variant 2: null
null
denied_reasonsstring[]required

Every reason that applies, in this order: auction, lockout_delinquency, lockout_manual, overlock.

Show denied_reasons schema
string
denied_sincestring | null

When the provider confirmed it holds the unit denied.

Format: date-time

Show denied_since schema
string | null

When the provider confirmed it holds the unit denied.

Variant 1: string
string
Variant 2: null
null
lease_idstringrequired

The 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
codestringrequired

The code, for example tenant_unlinked or credential_rejected.

messagestringrequired

What the code means, in a sentence to show staff.

link_statusstringrequired

linked, unlinked or excluded. Only a linked unit is sent to the provider.

providerstringrequired

The provider, for example kiss.

sync_statusstring | null

synced, pending, failed, blocked or held, once linked.

Show sync_status schema
string | null

synced, pending, failed, blocked or held, once linked.

Variant 1: string
string
Variant 2: null
null
manual_holdAccessManualHoldResponse | null

The manual hold, if one is placed.

Show manual_hold schema
AccessManualHoldResponse | null

The manual hold, if one is placed.

Variant 1: AccessManualHoldResponse
notestring | null

What they recorded; null without permission to read tenants.

Show note schema
string | null

What they recorded; null without permission to read tenants.

Variant 1: string
Variant 2: null
placed_atstring | null

When it was placed.

Format: date-time

Show placed_at schema
string | null

When it was placed.

Variant 1: string
Variant 2: null
placed_bystring | null

Who placed it.

Format: uuid

Show placed_by schema
string | null

Who placed it.

Variant 1: string
Variant 2: null
placed_by_namestring | null

Their name.

Show placed_by_name schema
string | null

Their name.

Variant 1: string
Variant 2: null
reasonstringrequired

violation, safety or other.

Variant 2: null
null
no_open_casebooleanrequired

True 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 | null

The earliest start Facily keeps among the reasons.

Format: date-time

Show since schema
string | null

The earliest start Facily keeps among the reasons.

Variant 1: string
string
Variant 2: null
null
suspended_atstring | null

When the delinquency lockout began.

Format: date-time

Show suspended_at schema
string | null

When the delinquency lockout began.

Variant 1: string
string
Variant 2: null
null
tenant_idstring | null

The tenant.

Format: uuid

Show tenant_id schema
string | null

The tenant.

Variant 1: string
string
Variant 2: null
null
tenant_namestring | null

Their name; null without permission to read tenants.

Show tenant_name schema
string | null

Their name; null without permission to read tenants.

Variant 1: string
string
Variant 2: null
null
unit_idstringrequired

The unit.

Format: uuid

unit_numberstringrequired

Its number.

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
Build something that works beautifully.

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

List Access Lockouts | Facily Developers