Get partner clients V2
curl --request POST \
--url https://api2.rhombussystems.com/api/partner/getClientsV2 \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"includeDeactivated": true
}
'import requests
url = "https://api2.rhombussystems.com/api/partner/getClientsV2"
payload = { "includeDeactivated": True }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({includeDeactivated: true})
};
fetch('https://api2.rhombussystems.com/api/partner/getClientsV2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/partner/getClientsV2")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"includeDeactivated\": true\n}")
.asString();{
"clients": [
{
"authorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"clientAccessAllowed": true,
"clientAccountAccessUrl": "https://console.rhombussystems.com/client/access",
"clientOrgName": "Acme Corporation",
"clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"clientSuperAdminAssignable": true,
"createdAtMillis": 1640995200000,
"deactivated": true,
"deactivatedAtMillis": 123,
"managedByMsp": true,
"totalAudioGateways": 4,
"totalBadgeReaders": 12,
"totalCameras": 25,
"totalClimateSensors": 10,
"totalDoorSensors": 8,
"totalLocations": 3,
"totalOccupancySensors": 6,
"totalProximitySensors": 5
}
],
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Partner Webservice
Get partner clients V2
Get a list of all client accounts. NOTICE: This is the same as getPartnerClients, but only returns the basic info so partners can login to clients quickly. The other info will be returned by getPartnerClientsStatusMap.
POST
/
api
/
partner
/
getClientsV2
Get partner clients V2
curl --request POST \
--url https://api2.rhombussystems.com/api/partner/getClientsV2 \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"includeDeactivated": true
}
'import requests
url = "https://api2.rhombussystems.com/api/partner/getClientsV2"
payload = { "includeDeactivated": True }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({includeDeactivated: true})
};
fetch('https://api2.rhombussystems.com/api/partner/getClientsV2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/partner/getClientsV2")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"includeDeactivated\": true\n}")
.asString();{
"clients": [
{
"authorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"clientAccessAllowed": true,
"clientAccountAccessUrl": "https://console.rhombussystems.com/client/access",
"clientOrgName": "Acme Corporation",
"clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"clientSuperAdminAssignable": true,
"createdAtMillis": 1640995200000,
"deactivated": true,
"deactivatedAtMillis": 123,
"managedByMsp": true,
"totalAudioGateways": 4,
"totalBadgeReaders": 12,
"totalCameras": 25,
"totalClimateSensors": 10,
"totalDoorSensors": 8,
"totalLocations": 3,
"totalOccupancySensors": 6,
"totalProximitySensors": 5
}
],
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Authorizations
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
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.
MSP initiative: also return soft-deleted (deactivated) client orgs still inside the restore window. Default false.
Last modified on October 5, 2026