Skip to main content
POST
/
api
/
org
/
getFeatures
Get organization features
curl --request POST \
  --url https://api2.rhombussystems.com/api/org/getFeatures \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "behaviorDetection": false,
  "cloudArchiving": false,
  "engagementCounting": false,
  "error": true,
  "errorMsg": "<string>",
  "faceCounting": false,
  "faceCountingNonUnique": false,
  "faceRecognition": false,
  "licensePlateRecognition": false,
  "peopleCounting": false,
  "ppeDetection": false,
  "rulesEngine": false,
  "vehicleCounting": false,
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting organization features.

Response

200 - application/json

OK

Response object containing organization feature flags.

​
behaviorDetection
boolean | null

Whether behavior detection is enabled

Example:

false

​
cloudArchiving
boolean | null

Whether cloud archiving is enabled

Example:

false

​
engagementCounting
boolean | null

Whether engagement counting is enabled

Example:

false

​
error
boolean | null
​
errorMsg
string | null
​
faceCounting
boolean | null

Whether face counting is enabled

Example:

false

​
faceCountingNonUnique
boolean | null

Whether non-unique face counting is enabled

Example:

false

​
faceRecognition
boolean | null

Whether face recognition is enabled

Example:

false

​
licensePlateRecognition
boolean | null

Whether license plate recognition is enabled

Example:

false

​
peopleCounting
boolean | null

Whether people counting is enabled

Example:

false

​
ppeDetection
boolean | null

Whether PPE detection is enabled

Example:

false

​
rulesEngine
boolean | null

Whether rules engine is enabled (deprecated)

Example:

false

​
vehicleCounting
boolean | null

Whether vehicle counting is enabled

Example:

false

​
warningMsg
string | null