Skip to main content
POST
Get users in organization

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 August 7, 2026