Skip to main content
POST
/
api
/
component
/
findPaginatedComponentEventsByAccessControlledDoor
Retrieve all component events relevant to the specified AccessControlledDoor
curl --request POST \
  --url https://api2.rhombussystems.com/api/component/findPaginatedComponentEventsByAccessControlledDoor \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "accessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "createdAfterMs": 123,
  "createdBeforeMs": 123,
  "lastEvaluatedKey": "<string>",
  "maxPageSize": 123,
  "reverseSearch": true,
  "typeFilter": [
    "DoorbellEvent"
  ],
  "userFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ]
}
'
{
  "componentEvents": [
    {
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "newSupervisionState": "CUT_DETECTED",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "correlationId": "<string>",
      "createdAtMs": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "timestampMs": 123,
      "type": "DoorbellEvent",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "lastEvaluatedKey": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json
accessControlledDoorUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

createdAfterMs
integer<int64> | null
createdBeforeMs
integer<int64> | null
lastEvaluatedKey
string | null
maxPageSize
integer<int32> | null
reverseSearch
boolean | null
typeFilter
enum<string>[] | null

Limits results to only contain the specified type of events, if applicable

Available options:
DoorbellEvent,
DoorReaderStateChangeEvent,
DoorRelayStateChangeEvent,
DoorPositionIndicatorStateChangeEvent,
RequestToExitStateChangeEvent,
CredentialReceivedEvent,
ButtonEvent,
GenericInputStateChangeEvent,
GenericRelayStateChangeEvent,
AccessControlUnitTamperEvent,
AccessControlUnitLocationLockdownStateEvent,
DoorLocationLockdownStateEvent,
PanicButtonEvent,
AccessControlUnitBatteryStateChangeEvent,
WaveToUnlockIntentExpiredEvent,
DoorStateChangeEvent,
DoorAuthFirstInStateEvent,
DoorScheduleFirstInStateEvent,
AccessControlUnitDoorFirstInStateEvent,
AperioDoorExtensionStateEvent,
AperioActivatorStateEvent,
AperioKeyCylinderStateEvent,
AperioDoorModeEvent,
AperioDoorHandleStateEvent,
AperioGatewayStateEvent,
AperioGatewayConnectionStateChangeEvent,
AperioDtcEvent,
AperioTamperStateEvent
userFilter
(string<RUUID> | null)[] | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Request object for getting list of component events for the specified door with pagination support.

componentEvents
object[] | null

List of component events for the doorbell camera

error
boolean | null
errorMsg
string | null
lastEvaluatedKey
string | null
warningMsg
string | null