Skip to main content
POST
Get rules filtered

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 filtered rules.

associatedUuids
(string<RUUID> | null)[] | null

List of associated UUIDs to filter by

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

ruleTypeFilter
enum<string>[] | null

List of rule types to filter by

Available options:
BUTTON_DEFINED,
USER_DEFINED,
DOORBELL_CAMERA_DEFINED,
DOOR_CONTROLLER_DEFINED,
LOCKDOWN_PLAN_DEFINED,
CUSTOM_LLM_DEFINED,
ROBOT_DEFINED,
SCHEDULED_REPORT_DEFINED

Response

200 - application/json

OK

Response object for getting rules for an organization.

error
boolean | null
errorMsg
string | null
rules
object[] | null

List of rules for the organization

warningMsg
string | null
Last modified on August 21, 2026