Skip to main content
POST
/
api
/
component
/
findComponentEventsByGuestPass
Retrieve all component events relevant to the specified guest pass
curl --request POST \
  --url https://api2.rhombussystems.com/api/component/findComponentEventsByGuestPass \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "createdAfterMs": 123,
  "createdBeforeMs": 123,
  "guestPassUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "limit": 123,
  "typeFilter": []
}
'
import requests

url = "https://api2.rhombussystems.com/api/component/findComponentEventsByGuestPass"

payload = {
"createdAfterMs": 123,
"createdBeforeMs": 123,
"guestPassUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"limit": 123,
"typeFilter": []
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
createdAfterMs: 123,
createdBeforeMs: 123,
guestPassUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
limit: 123,
typeFilter: []
})
};

fetch('https://api2.rhombussystems.com/api/component/findComponentEventsByGuestPass', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/findComponentEventsByGuestPass")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"createdAfterMs\": 123,\n \"createdBeforeMs\": 123,\n \"guestPassUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"limit\": 123,\n \"typeFilter\": []\n}")
.asString();
{
  "componentEvents": [
    {
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "correlationId": "<string>",
      "createdAtMs": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "timestampMs": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

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
createdAfterMs
integer<int64> | null
createdBeforeMs
integer<int64> | null
guestPassUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

limit
integer<int32> | 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

Response

200 - application/json

OK

componentEvents
object[] | null

List of component events for the doorbell camera

Last modified on July 9, 2026