🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
curl --request POST \
--url https://api2.rhombussystems.com/api/user/getUsersInOrg \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'{
"error": true,
"errorMsg": "<string>",
"notificationSettings": [
{
"notificationIntervalsV2": [
{
"activityTriggerMap": {},
"deviceFilterSet": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"diagnosticTriggerMap": {},
"locationActivityTriggerMap": {},
"locationDiagnosticTriggerMap": {},
"locationFilterSet": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationOnlyFilterSet": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"minuteOfWeekStart": 123,
"minuteOfWeekStop": 123
}
],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"smsPhoneNumbers": [
"<string>"
],
"summaryEmailEnabled": true,
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"notificationSettingsV2": [
{
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"smsPhoneNumbers": [
"<string>"
],
"summaryEmailEnabled": true,
"timeFrames": [
{
"days": [
"MONDAY"
],
"interval": {
"dayOfWeek": 123,
"minuteOfDayStartInclusive": 123,
"minuteOfDayStopExclusive": 123
},
"mediums": [
"SMS"
],
"rows": [
{
"activities": [
"SOUND_LOUD"
],
"devices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"diagnostics": [
"CAMERA_CONNECTED"
],
"locationOnly": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationOnlyActivities": [
"SOUND_LOUD"
],
"locationOnlyDiagnostics": [
"CAMERA_CONNECTED"
],
"locations": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"promptUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
}
]
}
],
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"partners": [
{
"accessibleRhombusApps": [
"PARTNER"
],
"accountOwner": true,
"bypassSaml": true,
"changePasswordOnLogin": true,
"createdAtMillis": 123,
"deleted": true,
"email": "<string>",
"emailCaseSensitive": "<string>",
"emailVerified": true,
"firstName": "<string>",
"lastName": "<string>",
"mfaEnabled": true,
"mfaTokenType": "EMAIL",
"name": "<string>",
"orgUserCustomizationFlags": {},
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"passwordSet": true,
"rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"status": "JOINED",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"rhombusKeyAppConfigs": [
{
"createdAtMillis": 123,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"preferences": {
"favoriteAccessControlledDoorUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"rhombusOrgUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"settings": {
"bypassSaml": true,
"credentialProvisioningRules": {
"endDateProvisioner": {
"type": "<string>",
"value": 123
},
"maxMobileCredsAllowed": 123,
"startDateProvisioner": {
"type": "<string>",
"value": 123
}
},
"remoteUnlockEnabled": true,
"rhombusKeyAccessEnabled": true
},
"updatedAtMillis": 123
}
],
"snoozeSettings": [
{
"snoozedForAllNotificationsIntervals": [
{
"durationSecs": 123,
"timestampSec": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"snoozedForDevicesMap": {},
"snoozedForLocationsMap": {},
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"userPermissions": [
{
"groupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"users": [
{
"accessibleRhombusApps": [
"PARTNER"
],
"accountOwner": true,
"bypassSaml": true,
"changePasswordOnLogin": true,
"createdAtMillis": 123,
"deleted": true,
"email": "<string>",
"emailCaseSensitive": "<string>",
"emailVerified": true,
"firstName": "<string>",
"lastName": "<string>",
"mfaEnabled": true,
"mfaTokenType": "EMAIL",
"name": "<string>",
"orgUserCustomizationFlags": {},
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"passwordSet": true,
"rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"status": "JOINED",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Get list of all users in organization with complete user details, permissions, notification settings, and partner information.
curl --request POST \
--url https://api2.rhombussystems.com/api/user/getUsersInOrg \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'{
"error": true,
"errorMsg": "<string>",
"notificationSettings": [
{
"notificationIntervalsV2": [
{
"activityTriggerMap": {},
"deviceFilterSet": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"diagnosticTriggerMap": {},
"locationActivityTriggerMap": {},
"locationDiagnosticTriggerMap": {},
"locationFilterSet": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationOnlyFilterSet": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"minuteOfWeekStart": 123,
"minuteOfWeekStop": 123
}
],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"smsPhoneNumbers": [
"<string>"
],
"summaryEmailEnabled": true,
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"notificationSettingsV2": [
{
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"smsPhoneNumbers": [
"<string>"
],
"summaryEmailEnabled": true,
"timeFrames": [
{
"days": [
"MONDAY"
],
"interval": {
"dayOfWeek": 123,
"minuteOfDayStartInclusive": 123,
"minuteOfDayStopExclusive": 123
},
"mediums": [
"SMS"
],
"rows": [
{
"activities": [
"SOUND_LOUD"
],
"devices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"diagnostics": [
"CAMERA_CONNECTED"
],
"locationOnly": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationOnlyActivities": [
"SOUND_LOUD"
],
"locationOnlyDiagnostics": [
"CAMERA_CONNECTED"
],
"locations": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"promptUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
}
]
}
],
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"partners": [
{
"accessibleRhombusApps": [
"PARTNER"
],
"accountOwner": true,
"bypassSaml": true,
"changePasswordOnLogin": true,
"createdAtMillis": 123,
"deleted": true,
"email": "<string>",
"emailCaseSensitive": "<string>",
"emailVerified": true,
"firstName": "<string>",
"lastName": "<string>",
"mfaEnabled": true,
"mfaTokenType": "EMAIL",
"name": "<string>",
"orgUserCustomizationFlags": {},
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"passwordSet": true,
"rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"status": "JOINED",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"rhombusKeyAppConfigs": [
{
"createdAtMillis": 123,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"preferences": {
"favoriteAccessControlledDoorUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"rhombusOrgUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"settings": {
"bypassSaml": true,
"credentialProvisioningRules": {
"endDateProvisioner": {
"type": "<string>",
"value": 123
},
"maxMobileCredsAllowed": 123,
"startDateProvisioner": {
"type": "<string>",
"value": 123
}
},
"remoteUnlockEnabled": true,
"rhombusKeyAccessEnabled": true
},
"updatedAtMillis": 123
}
],
"snoozeSettings": [
{
"snoozedForAllNotificationsIntervals": [
{
"durationSecs": 123,
"timestampSec": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"snoozedForDevicesMap": {},
"snoozedForLocationsMap": {},
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"userPermissions": [
{
"groupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"users": [
{
"accessibleRhombusApps": [
"PARTNER"
],
"accountOwner": true,
"bypassSaml": true,
"changePasswordOnLogin": true,
"createdAtMillis": 123,
"deleted": true,
"email": "<string>",
"emailCaseSensitive": "<string>",
"emailVerified": true,
"firstName": "<string>",
"lastName": "<string>",
"mfaEnabled": true,
"mfaTokenType": "EMAIL",
"name": "<string>",
"orgUserCustomizationFlags": {},
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"passwordSet": true,
"rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"status": "JOINED",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9Request object for getting all users in the organization.
OK
Response object containing all users in the organization with their settings and permissions.
List of user notification settings (V3)
Show child attributes
List of user notification settings (V4)
Show child attributes
List of partner users in the organization
Show child attributes
List of Rhombus Key app configurations
Show child attributes
List of user snooze notification settings
Show child attributes
List of user permissions
Show child attributes
List of users in the organization
Show child attributes
Was this page helpful?