Skip to main content
POST
Retrieve all component events relevant to the specified Doorbell Camera

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

Request object for retrieving component events for a doorbell camera.

doorbellCameraUuid
string<RUUID> | null
required
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

limit
integer<int32> | null
required
int32

Limits the number of returned events to the latest LIMIT events. Maximum value is 100.

Example:

50

createdAfterMs
integer<int64> | null
int64

Returns events created after (exclusive) the specified millisecond epoch timestamp

Example:

1640995200000

createdBeforeMs
integer<int64> | null
int64

Returns events created before (exclusive) the specified millisecond epoch timestamp

Example:

1640995200000

typeFilter
enum<string>[] | null

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

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

Response

200 - application/json

OK

Response object containing component events for a doorbell camera.

componentEvents
object[] | null

List of component events for the doorbell camera

List of component events for the doorbell camera

error
boolean | null
errorMsg
string | null
warningMsg
string | null
Last modified on August 9, 2026