Skip to main content
POST
/
api
/
keypad
/
getKeypadsForOrg
Get keypads for organization
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 '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "keypads": [
    {
      "armCountdownSecs": 123,
      "buildingAdminPhoneNumber": "<string>",
      "connectionState": "ONLINE",
      "floorNumber": 123,
      "ipAddress": "<string>",
      "lastModified": 123,
      "latitude": 123,
      "locationName": "<string>",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "logoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": 123,
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "platform": "ANDROID",
      "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 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 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

warningMsg
string | null