/v1/facilities/{facility_id}/access/units/{unit_id}Authentication
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/units/<UNIT_ID>' \
--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
unit_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataAccessUnitDetailResponserequiredWhat Facily sent a provider for one unit, and what the provider confirmed.
Show data schema
denied_reasonsstring[]requiredEvery reason access is denied; empty when it is not.
Show denied_reasons schema
stringfactsAccessUnitFactsResponserequiredWhat Facily asserts about the unit.
Show facts schema
auction_scheduledbooleanrequiredAn auction is scheduled on the lease's open case.
delinquency_exemptbooleanrequiredThe tenant is exempt from delinquency lockouts.
gate_suspendedbooleanrequiredA delinquency lockout is on the lease.
lease_idstring | nullThat lease.
Format: uuid
Show lease_id schema
string | nullThat lease.
Variant 1: string
stringVariant 2: null
nullmanual_holdbooleanrequiredA manual hold is on the lease.
move_in_datestring | nullThe move-in date.
Format: date
Show move_in_date schema
string | nullThe move-in date.
Variant 1: string
stringVariant 2: null
nulloccupiedbooleanrequiredTrue while an active lease holds the unit.
out_of_servicebooleanrequiredThe unit is out of service.
status_labelstringrequiredThe unit's status in Facily.
tenant_idstring | nullIts tenant.
Format: uuid
Show tenant_id schema
string | nullIts tenant.
Variant 1: string
stringVariant 2: null
nullunit_overlockedbooleanrequiredThe unit is overlocked.
last_provider_eventAccessEventResponse | nullThe unit's latest provider event.
Show last_provider_event schema
AccessEventResponse | nullThe unit's latest provider event.
Variant 1: AccessEventResponse
access_grant_idstring | nullThe grant a Facily event changed.
Format: uuid
Show access_grant_id schema
string | nullThe grant a Facily event changed.
Variant 1: string
Variant 2: null
after_lockoutbooleanrequiredAn open at a time the provider held the unit locked out.
event_typestringrequiredunit_access, gate_entry, denied, failed_attempt, provider_event, granted, suspended, reinstated, hold_placed, hold_released or revoked.
idstringrequiredUnique identifier for this event.
Format: uuid
occurred_atstringrequiredWhen it happened.
Format: date-time
performer_namestring | nullThe name the provider recorded for the person; null without permission to read tenants.
Show performer_name schema
string | nullThe name the provider recorded for the person; null without permission to read tenants.
Variant 1: string
Variant 2: null
providerstring | nullThe provider the row came from.
Show provider schema
string | nullThe provider the row came from.
Variant 1: string
Variant 2: null
provider_keystring | nullThe provider's own name for the event.
Show provider_key schema
string | nullThe provider's own name for the event.
Variant 1: string
Variant 2: null
provider_unit_namestring | nullThe 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 | nullThe 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 | nullWhy Facily made the change, for a grant event.
Show reason schema
string | nullWhy Facily made the change, for a grant event.
Variant 1: string
Variant 2: null
recorded_atstringrequiredWhen the provider received it (provider rows) or Facily wrote it; a late upload shows here.
Format: date-time
sourcestringrequiredprovider 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 | nullThe tenant of that grant.
Format: uuid
Show tenant_id schema
string | nullThe tenant of that grant.
Variant 1: string
Variant 2: null
time_unreportedbooleanrequiredThe device reported no time; occurred_at is when the provider got it.
unconfirmedbooleanrequiredThe device did not confirm the lock moved.
unit_idstring | nullThe unit, when the event names one.
Format: uuid
Show unit_id schema
string | nullThe unit, when the event names one.
Variant 1: string
Variant 2: null
unit_numberstring | nullThat unit's number.
Show unit_number schema
string | nullThat unit's number.
Variant 1: string
Variant 2: null
Variant 2: null
nulllinksAccessUnitLinkDetailResponse[]requiredThe unit's sync with each provider.
Show links schema
acknowledgedobjectrequiredWhat the provider last confirmed it holds for the unit; a part it has not confirmed is absent.
attemptsintegerrequiredFailed attempts in a row.
denied_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
nullholdsAccessCodeResponse[]requiredWork deliberately held, and why.
Show holds schema
codestringrequiredThe code, for example tenant_unlinked or credential_rejected.
messagestringrequiredWhat the code means, in a sentence to show staff.
last_denied_fromstring | nullWhen the previous denial began.
Format: date-time
Show last_denied_from schema
string | nullWhen the previous denial began.
Variant 1: string
stringVariant 2: null
nulllast_denied_untilstring | nullWhen the previous denial ended.
Format: date-time
Show last_denied_until schema
string | nullWhen the previous denial ended.
Variant 1: string
stringVariant 2: null
nulllast_errorAccessCodeResponse | nullWhy the last attempt did not finish.
Show last_error schema
AccessCodeResponse | nullWhy the last attempt did not finish.
Variant 1: AccessCodeResponse
codestringrequiredThe code, for example tenant_unlinked or credential_rejected.
messagestringrequiredWhat the code means, in a sentence to show staff.
Variant 2: null
nulllast_error_fieldstring | nullThe field the provider named, when it refused one.
Show last_error_field schema
string | nullThe field the provider named, when it refused one.
Variant 1: string
stringVariant 2: null
nulllast_pushed_atstring | nullWhen Facily last sent a change.
Format: date-time
Show last_pushed_at schema
string | nullWhen Facily last sent a change.
Variant 1: string
stringVariant 2: null
nulllast_verified_atstring | nullWhen Facily last compared with the provider.
Format: date-time
Show last_verified_at schema
string | nullWhen Facily last compared with the provider.
Variant 1: string
stringVariant 2: null
nulllink_detailAccessCodeResponse | nullWhy the link is as it is, when recorded.
Show link_detail schema
AccessCodeResponse | nullWhy the link is as it is, when recorded.
Variant 1: AccessCodeResponse
codestringrequiredThe code, for example tenant_unlinked or credential_rejected.
messagestringrequiredWhat the code means, in a sentence to show staff.
Variant 2: null
nulllink_statusstringrequiredlinked, unlinked or excluded.
next_attempt_atstring | nullWhen the next attempt is due.
Format: date-time
Show next_attempt_at schema
string | nullWhen the next attempt is due.
Variant 1: string
stringVariant 2: null
nullpending_sincestring | nullSince when work has waited.
Format: date-time
Show pending_since schema
string | nullSince when work has waited.
Variant 1: string
stringVariant 2: null
nullproviderstringrequiredThe provider.
provider_unit_idstring | nullThe provider's identifier for the unit.
Show provider_unit_id schema
string | nullThe provider's identifier for the unit.
Variant 1: string
stringVariant 2: null
nullreassert_duebooleanrequiredTrue when the flags are to be sent again even if unchanged.
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
nulltenant_link_statusstring | nullThe tenant's link: new, linked or needs_review.
Show tenant_link_status schema
string | nullThe tenant's link: new, linked or needs_review.
Variant 1: string
stringVariant 2: null
nulltenant_owns_contactboolean | nullTrue when this tenant's name and phone are the ones sent to the provider's account.
Show tenant_owns_contact schema
boolean | nullTrue when this tenant's name and phone are the ones sent to the provider's account.
Variant 1: boolean
booleanVariant 2: null
nulltenant_warningsAccessCodeResponse[]requiredWarnings about the tenant's account.
Show tenant_warnings schema
codestringrequiredThe code, for example tenant_unlinked or credential_rejected.
messagestringrequiredWhat the code means, in a sentence to show staff.
vacated_atstring | nullWhen 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 | nullWhen the provider last confirmed it vacated the unit, while a phone may still hold keys for it; null otherwise.
Variant 1: string
stringVariant 2: null
nullwarningsAccessCodeResponse[]requiredWarnings about the unit.
Show warnings schema
codestringrequiredThe code, for example tenant_unlinked or credential_rejected.
messagestringrequiredWhat the code means, in a sentence to show staff.
open_itemsAccessOpenItemResponse[]requiredOpen findings about the unit or its tenant.
Show open_items schema
idstringrequiredThe finding.
Format: uuid
kindstringrequiredWhat kind of finding it is.
providerstringrequiredThe 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
stringworker_raisedbooleanrequiredTrue when the sync engine raised it after lock sync started; false for a finding from linking.
phone_last4string | nullThe last four digits of the tenant's phone; null without permission to read tenants.
Show phone_last4 schema
string | nullThe last four digits of the tenant's phone; null without permission to read tenants.
Variant 1: string
stringVariant 2: null
nulltenant_namestring | nullThe tenant's name; null without permission to read tenants.
Show tenant_name schema
string | nullThe tenant's 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_idstringrequired400Validation 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