Skip to main content
POST
/
api
/
user
/
getUsersInOrg
Get users in organization
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": [],
          "interval": {
            "dayOfWeek": 123,
            "minuteOfDayStartInclusive": 123,
            "minuteOfDayStopExclusive": 123
          },
          "mediums": [],
          "rows": [
            {
              "activities": [],
              "devices": [
                "AAAAAAAAAAAAAAAAAAAAAA.v0"
              ],
              "diagnostics": [],
              "locationOnly": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "locationOnlyActivities": [],
              "locationOnlyDiagnostics": [],
              "locations": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "promptUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ]
            }
          ]
        }
      ],
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "partners": [
    {
      "accessibleRhombusApps": [],
      "accountOwner": true,
      "bypassSaml": true,
      "changePasswordOnLogin": true,
      "createdAtMillis": 123,
      "deleted": true,
      "email": "<string>",
      "emailCaseSensitive": "<string>",
      "emailVerified": true,
      "firstName": "<string>",
      "lastName": "<string>",
      "mfaEnabled": true,
      "name": "<string>",
      "orgUserCustomizationFlags": {},
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "passwordSet": true,
      "rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "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": [],
      "accountOwner": true,
      "bypassSaml": true,
      "changePasswordOnLogin": true,
      "createdAtMillis": 123,
      "deleted": true,
      "email": "<string>",
      "emailCaseSensitive": "<string>",
      "emailVerified": true,
      "firstName": "<string>",
      "lastName": "<string>",
      "mfaEnabled": true,
      "name": "<string>",
      "orgUserCustomizationFlags": {},
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "passwordSet": true,
      "rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "updatedAtMillis": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "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

Request object for getting all users in the organization.

Response

200 - application/json

OK

Response object containing all users in the organization with their settings and permissions.

​
error
boolean | null
​
errorMsg
string | null
​
notificationSettings
object[] | null

List of user notification settings (V3)

​
notificationSettingsV2
object[] | null

List of user notification settings (V4)

​
partners
object[] | null

List of partner users in the organization

​
rhombusKeyAppConfigs
object[] | null

List of Rhombus Key app configurations

​
snoozeSettings
object[] | null

List of user snooze notification settings

​
userPermissions
object[] | null

List of user permissions

​
users
object[] | null

List of users in the organization

​
warningMsg
string | null
Last modified on June 6, 2026