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

List Access Events

Access control · REST API reference

Get support
GET/v1/facilities/{facility_id}/access/events
The feed, newest first by when it happened. Keyset only (`cursor`): `from` is aliased (a keyword).

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/events' \
  --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

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

event_typequery · string | null

One event type, or several separated by commas.

unit_idquery · string | null

Only events for this unit.

Format: uuid

fromquery · string | null

Inclusive lower bound on when it happened.

Format: date-time

toquery · string | null

Exclusive upper bound on when it happened.

Format: date-time

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "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"
    }
  ],
  "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

dataAccessEventResponse[]required
Show data schema
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
string
Variant 2: null
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
string
Variant 2: null
null
providerstring | null

The provider the row came from.

Show provider schema
string | null

The provider the row came from.

Variant 1: string
string
Variant 2: null
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
string
Variant 2: null
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
string
Variant 2: null
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
string
Variant 2: null
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
string
Variant 2: null
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
string
Variant 2: null
null
unit_numberstring | null

That unit's number.

Show unit_number schema
string | null

That unit's number.

Variant 1: string
string
Variant 2: null
null
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 Events | Facily Developers