Get minimal proximity state list
curl --request POST \
--url https://api2.rhombussystems.com/api/proximity/getMinimalProximityStateList \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'import requests
url = "https://api2.rhombussystems.com/api/proximity/getMinimalProximityStateList"
payload = {}
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({})
};
fetch('https://api2.rhombussystems.com/api/proximity/getMinimalProximityStateList', 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/proximity/getMinimalProximityStateList")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();{
"error": true,
"errorMsg": "<string>",
"proximityStates": [
{
"batteryPercent": 75,
"createdAtMillis": 1640995200000,
"firmwareVersion": "1.2.3",
"gpsLocation": {
"error": {
"majorAxis": 123,
"minorAxis": 123,
"rotation": 123
},
"floor": 123,
"lat": 123,
"lon": 123
},
"health": "GREEN",
"healthDetails": "FIRMWARE_BEHIND",
"hwVariation": "RASPBERRY_PI_3",
"imageUrl": "https://example.com/badge-image.jpg",
"lastSeenSec": 1640995200,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "Employee Badge 001",
"policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"serialNumber": "PROX-001-ABC123",
"signalStrength": 85,
"status": "ACTIVE",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
"tagUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Proximity Webservice
Get minimal proximity state list
Get basic state information about all proximity tags in organization
POST
/
api
/
proximity
/
getMinimalProximityStateList
Get minimal proximity state list
curl --request POST \
--url https://api2.rhombussystems.com/api/proximity/getMinimalProximityStateList \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'import requests
url = "https://api2.rhombussystems.com/api/proximity/getMinimalProximityStateList"
payload = {}
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({})
};
fetch('https://api2.rhombussystems.com/api/proximity/getMinimalProximityStateList', 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/proximity/getMinimalProximityStateList")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();{
"error": true,
"errorMsg": "<string>",
"proximityStates": [
{
"batteryPercent": 75,
"createdAtMillis": 1640995200000,
"firmwareVersion": "1.2.3",
"gpsLocation": {
"error": {
"majorAxis": 123,
"minorAxis": 123,
"rotation": 123
},
"floor": 123,
"lat": 123,
"lon": 123
},
"health": "GREEN",
"healthDetails": "FIRMWARE_BEHIND",
"hwVariation": "RASPBERRY_PI_3",
"imageUrl": "https://example.com/badge-image.jpg",
"lastSeenSec": 1640995200,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "Employee Badge 001",
"policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"serialNumber": "PROX-001-ABC123",
"signalStrength": 85,
"status": "ACTIVE",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
"tagUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"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 basic state information about all proximity tags in the organization.
Response
200 - application/json
OK
Last modified on October 5, 2026