Get video intercom policies

Get details about all video intercom policies in organization

POST /api/policy/getVideoIntercomPolicies

Get video intercom policies

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/policy/getVideoIntercomPolicies \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "policies": [
    {
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            {
              "faceAlertLabelSet": [
                "<string>"
              ],
              "faceAlertUnidentified": true,
              "faceAllowedLabelSet": [
                "<string>"
              ],
              "lufsThreshold": 123,
              "peopleCountThreshold": 123,
              "vehicleAlertLabelSet": [
                "<string>"
              ],
              "vehicleAlertUnidentified": true,
              "vehicleAllowedLabelSet": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "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 video intercom policies in the organization.

Response

200 - application/json

OK

Response object containing all video intercom policies in the organization.

error · boolean | null

errorMsg · string | null

policies · object[] | null

List of video intercom policies in the organization

Show child attributes

warningMsg · string | null