/v1/facilities/{facility_id}/access/summaryAuthentication
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/summary' \
--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": {
"device_window_hours": 0,
"facility_id": "00000000-0000-4000-8000-000000000001",
"provider_active": false,
"providers": [
{
"link_counts": {
"excluded": 0,
"linked": 0,
"missing": 0,
"unlinked": 0
},
"open_items": 0,
"paused": false,
"provider": "string",
"sync_counts": {
"blocked": 0,
"failed": 0,
"held": 0,
"pending": 0,
"synced": 0
},
"unverified_24h": 0,
"activated_at": "2026-10-29T12:00:00Z",
"connection": {
"activity_available": false,
"lifecycle": "string",
"location_ref": "string",
"mode": "string"
},
"last_activity_deep_on": "2026-10-29",
"last_activity_poll_at": "2026-10-29T12:00:00Z",
"last_readback_at": "2026-10-29T12:00:00Z",
"last_reconciled_at": "2026-10-29T12:00:00Z"
}
]
},
"meta": {
"request_id": "string"
}
}application/json
dataAccessSummaryResponserequiredA facility's access-control state.
Show data schema
device_window_hoursintegerrequiredHow long a phone that already holds its keys may keep opening a lock after access ends.
facility_idstringrequiredThe facility.
Format: uuid
provider_activebooleanrequiredTrue when a provider enforces this facility's lockouts.
providersAccessProviderSummaryResponse[]requiredOne entry per provider.
Show providers schema
activated_atstring | nullWhen Facily started writing to the provider; null before.
Format: date-time
Show activated_at schema
string | nullWhen Facily started writing to the provider; null before.
Variant 1: string
stringVariant 2: null
nullconnectionAccessConnectionResponse | nullThe live connection, or null when the facility has none for this provider.
Show connection schema
AccessConnectionResponse | nullThe live connection, or null when the facility has none for this provider.
Variant 1: AccessConnectionResponse
activity_availablebooleanrequiredTrue when the connection may read the provider's access log.
lifecyclestringrequiredconnected, or frozen (still syncing, but no new work is started).
location_refstringrequiredThe provider's identifier for the location this facility is.
modestringrequiredlive; synthetic for a provider test location; read_only for a real location outside production.
Variant 2: null
nulllast_activity_deep_onstring | nullThe UTC day the long access-log pass last completed.
Format: date
Show last_activity_deep_on schema
string | nullThe UTC day the long access-log pass last completed.
Variant 1: string
stringVariant 2: null
nulllast_activity_poll_atstring | nullWhen the access log was last read in full.
Format: date-time
Show last_activity_poll_at schema
string | nullWhen the access log was last read in full.
Variant 1: string
stringVariant 2: null
nulllast_readback_atstring | nullWhen the provider's units were last read back.
Format: date-time
Show last_readback_at schema
string | nullWhen the provider's units were last read back.
Variant 1: string
stringVariant 2: null
nulllast_reconciled_atstring | nullWhen the last sync run reached this facility.
Format: date-time
Show last_reconciled_at schema
string | nullWhen the last sync run reached this facility.
Variant 1: string
stringVariant 2: null
nulllink_countsAccessLinkCountsResponserequiredUnits by link status with the provider.
Show link_counts schema
excludedintegerrequiredUnits staff chose not to sync.
linkedintegerrequiredUnits paired with a unit at the provider.
missingintegerrequiredUnits with no record for the provider at all.
unlinkedintegerrequiredUnits known but not yet paired.
open_itemsintegerrequiredFindings that need a person.
pauseAccessCodeResponse | nullWhy syncing is paused, when a reason is recorded.
Show pause schema
AccessCodeResponse | nullWhy syncing is paused, when a reason is 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
nullpausedbooleanrequiredTrue while syncing is paused, for a reason or a provider rate limit.
paused_untilstring | nullWhen a rate-limit pause ends.
Format: date-time
Show paused_until schema
string | nullWhen a rate-limit pause ends.
Variant 1: string
stringVariant 2: null
nullproviderstringrequiredThe provider, for example kiss.
sync_countsAccessSyncCountsResponserequiredLinked units by sync status.
Show sync_counts schema
blockedintegerrequiredUnits the provider refused a change for; retried later.
failedintegerrequiredUnits whose last send failed and will be retried.
heldintegerrequiredUnits with work deliberately held until someone acts.
pendingintegerrequiredUnits waiting to be sent.
syncedintegerrequiredUnits whose provider holds what Facily last sent.
unverified_24hintegerrequiredLinked units not compared with the provider in the last 24 hours.
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