Get keypads for organization

Get a list of all registered keypads for an org

POST /api/keypad/getKeypadsForOrg

Get keypads for organization

cURL

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

200

{
  "error": true,
  "errorMsg": "<string>",
  "keypads": [
    {
      "additionalFeaturesDisabled": true,
      "appVersionCode": "<string>",
      "appVersionName": "<string>",
      "armCountdownSecs": 123,
      "buildingAdminPhoneNumber": "<string>",
      "floorNumber": 123,
      "ipAddress": "<string>",
      "lastModified": 123,
      "latitude": 123,
      "locationName": "<string>",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "logoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": 123,
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "qualifiedAddress": {
        "addressLine2": "<string>",
        "addressline1": "<string>",
        "administrativeArea": "<string>",
        "locality": "<string>",
        "postalCode": "<string>",
        "regionCode": "<string>"
      },
      "showCallBuildingAdmin": true,
      "signalStrength": 123,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "tz": "<string>",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "videoWallUuid": "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 registered keypads for an organization.

Response

200 - application/json

OK

Response object containing all registered keypads for an organization.

error · boolean | null

errorMsg · string | null

keypads · object[] | null

List of all registered keypads for the organization

Show child attributes

warningMsg · string | null