StoreBay Developers
Access

List access events

GET
/access-events

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Query Parameters

cursor?string

Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.

limit?integer

Page size. Values above the maximum are clamped.

Range1 <= value <= 100
Default25
unit_id?string

Filter by unit.

Formatuuid
vendor?string

Filter by vendor.

Value in

  • "noke"
  • "bearbox"
  • "pti_cloud"
  • "opentech"
  • "paxton"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/access-events"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "access_event",      "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",      "unit_id": "5becc822-b69e-4e66-a762-ad8e868dcab6",      "hardware_device_id": "733523c8-861c-499f-8198-6cc819a34aad",      "access_credential_id": "0fa77fea-f2e0-4af5-a9e9-9609e747b88f",      "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",      "vendor": "noke",      "event_type": "unlock",      "external_event_id": "string",      "occurred_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "limit": 0,    "cursor": {      "next": "string",      "has_more": true    }  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}
{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}
{  "error": {    "code": "rate_limited",    "message": "Rate limit exceeded. Retry after 7s."  }}
{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}