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

Get Access Unit

Access control · REST API reference

Get support
GET/v1/facilities/{facility_id}/access/units/{unit_id}
What Facily sent the provider for one unit: the facts, the acknowledged state, warnings, the last event.

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/units/<UNIT_ID>' \
  --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_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"
    ],
    "facts": {
      "auction_scheduled": false,
      "delinquency_exempt": false,
      "gate_suspended": false,
      "manual_hold": false,
      "occupied": false,
      "out_of_service": false,
      "status_label": "string",
      "unit_overlocked": false,
      "lease_id": "00000000-0000-4000-8000-000000000001",
      "move_in_date": "2026-10-29",
      "tenant_id": "00000000-0000-4000-8000-000000000001"
    },
    "links": [
      {
        "acknowledged": {},
        "attempts": 0,
        "holds": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "link_status": "string",
        "provider": "string",
        "reassert_due": false,
        "tenant_warnings": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "warnings": [
          {
            "code": "string",
            "message": "string"
          }
        ],
        "denied_since": "2026-10-29T12:00:00Z",
        "last_denied_from": "2026-10-29T12:00:00Z",
        "last_denied_until": "2026-10-29T12:00:00Z",
        "last_error": {
          "code": "string",
          "message": "string"
        }
      }
    ],
    "open_items": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "kind": "string",
        "provider": "string",
        "worker_raised": false,
        "resolutions": [
          "string"
        ]
      }
    ],
    "unit_id": "00000000-0000-4000-8000-000000000001",
    "unit_number": "string",
    "last_provider_event": {
      "after_lockout": false,
      "event_type": "string",
      "id": "00000000-0000-4000-8000-000000000001",
      "occurred_at": "2026-10-29T12:00:00Z",
      "recorded_at": "2026-10-29T12:00:00Z",
      "source": "string",
      "time_unreported": false,
      "unconfirmed": false,
      "access_grant_id": "00000000-0000-4000-8000-000000000001",
      "performer_name": "string",
      "provider": "string",
      "provider_key": "string"
    },
    "phone_last4": "string",
    "tenant_name": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataAccessUnitDetailResponserequired

What Facily sent a provider for one unit, and what the provider confirmed.

Show data schema
denied_reasonsstring[]required

Every reason access is denied; empty when it is not.

Show denied_reasons schema
string
factsAccessUnitFactsResponserequired

What Facily asserts about the unit.

Show facts schema
auction_scheduledbooleanrequired

An auction is scheduled on the lease's open case.

delinquency_exemptbooleanrequired

The tenant is exempt from delinquency lockouts.

gate_suspendedbooleanrequired

A delinquency lockout is on the lease.

lease_idstring | null

That lease.

Format: uuid

Show lease_id schema
string | null

That lease.

Variant 1: string
string
Variant 2: null
null
manual_holdbooleanrequired

A manual hold is on the lease.

move_in_datestring | null

The move-in date.

Format: date

Show move_in_date schema
string | null

The move-in date.

Variant 1: string
string
Variant 2: null
null
occupiedbooleanrequired

True while an active lease holds the unit.

out_of_servicebooleanrequired

The unit is out of service.

status_labelstringrequired

The unit's status in Facily.

tenant_idstring | null

Its tenant.

Format: uuid

Show tenant_id schema
string | null

Its tenant.

Variant 1: string
string
Variant 2: null
null
unit_overlockedbooleanrequired

The unit is overlocked.

last_provider_eventAccessEventResponse | null

The unit's latest provider event.

Show last_provider_event schema
AccessEventResponse | null

The unit's latest provider event.

Variant 1: AccessEventResponse
access_grant_idstring | null

The grant a Facily event changed.

Format: uuid

Show access_grant_id schema
string | null

The grant a Facily event changed.

Variant 1: string
Variant 2: null
after_lockoutbooleanrequired

An open at a time the provider held the unit locked out.

event_typestringrequired

unit_access, gate_entry, denied, failed_attempt, provider_event, granted, suspended, reinstated, hold_placed, hold_released or revoked.

idstringrequired

Unique identifier for this event.

Format: uuid

occurred_atstringrequired

When it happened.

Format: date-time

performer_namestring | null

The name the provider recorded for the person; null without permission to read tenants.

Show performer_name schema
string | null

The name the provider recorded for the person; null without permission to read tenants.

Variant 1: string
Variant 2: null
providerstring | null

The provider the row came from.

Show provider schema
string | null

The provider the row came from.

Variant 1: string
Variant 2: null
provider_keystring | null

The provider's own name for the event.

Show provider_key schema
string | null

The provider's own name for the event.

Variant 1: string
Variant 2: null
provider_unit_namestring | null

The provider's own name for the unit, when the event names a provider unit no Facily unit matches; null otherwise.

Show provider_unit_name schema
string | null

The provider's own name for the unit, when the event names a provider unit no Facily unit matches; null otherwise.

Variant 1: string
Variant 2: null
reasonstring | null

Why Facily made the change, for a grant event.

Show reason schema
string | null

Why Facily made the change, for a grant event.

Variant 1: string
Variant 2: null
recorded_atstringrequired

When the provider received it (provider rows) or Facily wrote it; a late upload shows here.

Format: date-time

sourcestringrequired

provider for the provider's log; staff or system for Facily's own (the feed never lists a data load's migration grant events).

tenant_idstring | null

The tenant of that grant.

Format: uuid

Show tenant_id schema
string | null

The tenant of that grant.

Variant 1: string
Variant 2: null
time_unreportedbooleanrequired

The device reported no time; occurred_at is when the provider got it.

unconfirmedbooleanrequired

The device did not confirm the lock moved.

unit_idstring | null

The unit, when the event names one.

Format: uuid

Show unit_id schema
string | null

The unit, when the event names one.

Variant 1: string
Variant 2: null
unit_numberstring | null

That unit's number.

Show unit_number schema
string | null

That unit's number.

Variant 1: string
Variant 2: null
Variant 2: null
null
linksAccessUnitLinkDetailResponse[]required

The unit's sync with each provider.

Show links schema
acknowledgedobjectrequired

What the provider last confirmed it holds for the unit; a part it has not confirmed is absent.

attemptsintegerrequired

Failed attempts in a row.

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
holdsAccessCodeResponse[]required

Work deliberately held, and why.

Show holds schema
codestringrequired

The code, for example tenant_unlinked or credential_rejected.

messagestringrequired

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

last_denied_fromstring | null

When the previous denial began.

Format: date-time

Show last_denied_from schema
string | null

When the previous denial began.

Variant 1: string
string
Variant 2: null
null
last_denied_untilstring | null

When the previous denial ended.

Format: date-time

Show last_denied_until schema
string | null

When the previous denial ended.

Variant 1: string
string
Variant 2: null
null
last_errorAccessCodeResponse | null

Why the last attempt did not finish.

Show last_error schema
AccessCodeResponse | null

Why the last attempt did not finish.

Variant 1: AccessCodeResponse
codestringrequired

The code, for example tenant_unlinked or credential_rejected.

messagestringrequired

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

Variant 2: null
null
last_error_fieldstring | null

The field the provider named, when it refused one.

Show last_error_field schema
string | null

The field the provider named, when it refused one.

Variant 1: string
string
Variant 2: null
null
last_pushed_atstring | null

When Facily last sent a change.

Format: date-time

Show last_pushed_at schema
string | null

When Facily last sent a change.

Variant 1: string
string
Variant 2: null
null
last_verified_atstring | null

When Facily last compared with the provider.

Format: date-time

Show last_verified_at schema
string | null

When Facily last compared with the provider.

Variant 1: string
string
Variant 2: null
null
link_detailAccessCodeResponse | null

Why the link is as it is, when recorded.

Show link_detail schema
AccessCodeResponse | null

Why the link is as it is, when recorded.

Variant 1: AccessCodeResponse
codestringrequired

The code, for example tenant_unlinked or credential_rejected.

messagestringrequired

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

Variant 2: null
null
link_statusstringrequired

linked, unlinked or excluded.

next_attempt_atstring | null

When the next attempt is due.

Format: date-time

Show next_attempt_at schema
string | null

When the next attempt is due.

Variant 1: string
string
Variant 2: null
null
pending_sincestring | null

Since when work has waited.

Format: date-time

Show pending_since schema
string | null

Since when work has waited.

Variant 1: string
string
Variant 2: null
null
providerstringrequired

The provider.

provider_unit_idstring | null

The provider's identifier for the unit.

Show provider_unit_id schema
string | null

The provider's identifier for the unit.

Variant 1: string
string
Variant 2: null
null
reassert_duebooleanrequired

True when the flags are to be sent again even if unchanged.

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

The tenant's link: new, linked or needs_review.

Show tenant_link_status schema
string | null

The tenant's link: new, linked or needs_review.

Variant 1: string
string
Variant 2: null
null
tenant_owns_contactboolean | null

True when this tenant's name and phone are the ones sent to the provider's account.

Show tenant_owns_contact schema
boolean | null

True when this tenant's name and phone are the ones sent to the provider's account.

Variant 1: boolean
boolean
Variant 2: null
null
tenant_warningsAccessCodeResponse[]required

Warnings about the tenant's account.

Show tenant_warnings schema
codestringrequired

The code, for example tenant_unlinked or credential_rejected.

messagestringrequired

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

vacated_atstring | null

When the provider last confirmed it vacated the unit, while a phone may still hold keys for it; null otherwise.

Format: date-time

Show vacated_at schema
string | null

When the provider last confirmed it vacated the unit, while a phone may still hold keys for it; null otherwise.

Variant 1: string
string
Variant 2: null
null
warningsAccessCodeResponse[]required

Warnings about the unit.

Show warnings schema
codestringrequired

The code, for example tenant_unlinked or credential_rejected.

messagestringrequired

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

open_itemsAccessOpenItemResponse[]required

Open findings about the unit or its tenant.

Show open_items schema
idstringrequired

The finding.

Format: uuid

kindstringrequired

What kind of finding it is.

providerstringrequired

The provider it concerns.

resolutionsstring[]

What can be decided on this finding here: share_identity, separate_identity or vacate_confirmed. Empty when Facily staff decide it.

Show resolutions schema
string
worker_raisedbooleanrequired

True when the sync engine raised it after lock sync started; false for a finding from linking.

phone_last4string | null

The last four digits of the tenant's phone; null without permission to read tenants.

Show phone_last4 schema
string | null

The last four digits of the tenant's phone; null without permission to read tenants.

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

The tenant's name; null without permission to read tenants.

Show tenant_name schema
string | null

The tenant's 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
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

Get Access Unit | Facily Developers