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

Get Access Summary

Access control · REST API reference

Get support
GET/v1/facilities/{facility_id}/access/summary
Connection and activation state per provider, the pause, the counts, the last runs and the device note.

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/summary' \
  --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": {
    "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

dataAccessSummaryResponserequired

A facility's access-control state.

Show data schema
device_window_hoursintegerrequired

How long a phone that already holds its keys may keep opening a lock after access ends.

facility_idstringrequired

The facility.

Format: uuid

provider_activebooleanrequired

True when a provider enforces this facility's lockouts.

providersAccessProviderSummaryResponse[]required

One entry per provider.

Show providers schema
activated_atstring | null

When Facily started writing to the provider; null before.

Format: date-time

Show activated_at schema
string | null

When Facily started writing to the provider; null before.

Variant 1: string
string
Variant 2: null
null
connectionAccessConnectionResponse | null

The live connection, or null when the facility has none for this provider.

Show connection schema
AccessConnectionResponse | null

The live connection, or null when the facility has none for this provider.

Variant 1: AccessConnectionResponse
activity_availablebooleanrequired

True when the connection may read the provider's access log.

lifecyclestringrequired

connected, or frozen (still syncing, but no new work is started).

location_refstringrequired

The provider's identifier for the location this facility is.

modestringrequired

live; synthetic for a provider test location; read_only for a real location outside production.

Variant 2: null
null
last_activity_deep_onstring | null

The UTC day the long access-log pass last completed.

Format: date

Show last_activity_deep_on schema
string | null

The UTC day the long access-log pass last completed.

Variant 1: string
string
Variant 2: null
null
last_activity_poll_atstring | null

When the access log was last read in full.

Format: date-time

Show last_activity_poll_at schema
string | null

When the access log was last read in full.

Variant 1: string
string
Variant 2: null
null
last_readback_atstring | null

When the provider's units were last read back.

Format: date-time

Show last_readback_at schema
string | null

When the provider's units were last read back.

Variant 1: string
string
Variant 2: null
null
last_reconciled_atstring | null

When the last sync run reached this facility.

Format: date-time

Show last_reconciled_at schema
string | null

When the last sync run reached this facility.

Variant 1: string
string
Variant 2: null
null
link_countsAccessLinkCountsResponserequired

Units by link status with the provider.

Show link_counts schema
excludedintegerrequired

Units staff chose not to sync.

linkedintegerrequired

Units paired with a unit at the provider.

missingintegerrequired

Units with no record for the provider at all.

unlinkedintegerrequired

Units known but not yet paired.

open_itemsintegerrequired

Findings that need a person.

pauseAccessCodeResponse | null

Why syncing is paused, when a reason is recorded.

Show pause schema
AccessCodeResponse | null

Why syncing is paused, when a reason is 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
pausedbooleanrequired

True while syncing is paused, for a reason or a provider rate limit.

paused_untilstring | null

When a rate-limit pause ends.

Format: date-time

Show paused_until schema
string | null

When a rate-limit pause ends.

Variant 1: string
string
Variant 2: null
null
providerstringrequired

The provider, for example kiss.

sync_countsAccessSyncCountsResponserequired

Linked units by sync status.

Show sync_counts schema
blockedintegerrequired

Units the provider refused a change for; retried later.

failedintegerrequired

Units whose last send failed and will be retried.

heldintegerrequired

Units with work deliberately held until someone acts.

pendingintegerrequired

Units waiting to be sent.

syncedintegerrequired

Units whose provider holds what Facily last sent.

unverified_24hintegerrequired

Linked units not compared with the provider in the last 24 hours.

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 Summary | Facily Developers