Get partner clients

Get a list of all client accounts

POST /api/partner/getClients

Get partner clients

cURL

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

200

{
  "clients": [
    {
      "authorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "clientAccessAllowed": true,
      "clientAccountAccessUrl": "https://console.rhombussystems.com/client/access",
      "clientOrgName": "Acme Corporation",
      "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "createdAtMillis": 1640995200000,
      "totalAudioGateways": 4,
      "totalBadgeReaders": 12,
      "totalCameras": 25,
      "totalClimateSensors": 10,
      "totalDoorSensors": 8,
      "totalLocations": 3,
      "totalOccupancySensors": 6,
      "totalProximitySensors": 5
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "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: partner-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 partner clients.

Response

200 - application/json

OK

Response object containing list of partner clients.

clients · object[] | null

List of partner clients

Show child attributes

error · boolean | null

errorMsg · string | null

warningMsg · string | null