> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Get minimal occupancy sensor state list > Get basic state information about all proximity tags in organization ```http POST https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList ``` EU organizations send the same request to `https://api2.eu.rhombussystems.com`. ## Authentication and parameters - `x-auth-apikey` (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). - `Authorization` (header): instead of an API key, an OAuth access token (`Bearer `) with the `read` scope. - `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`. - `x-auth-org` (header, string): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`. ## Request body Content type: `application/json`. Request object for getting minimal occupancy sensor states for all sensors in organization. No fields: send `{}`. ## Response 200 OK. Content type: `application/json` - `error` (boolean | null) - `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg. - `errorMsg` (string | null) - `occupancySensorStates` (array | null): List of minimal occupancy sensor states - `warningMsg` (string | null) ## Errors Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors ## OpenAPI ````yaml openapi: 3.0.1 info: title: Rhombus API version: "1.0" servers: - description: Production Server url: https://api2.rhombussystems.com security: - ApiKeyAuth: [] paths: /api/occupancy/getMinimalOccupancySensorStateList: post: description: Get basic state information about all proximity tags in organization operationId: getMinimalOccupancySensorStateList parameters: - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters." example: api-token in: header name: x-auth-scheme required: false schema: default: api-token enum: - api-token - api - api-oauth-token - federated-token - partner-api-token - partner-api - partner-api-oauth-token type: string - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`." in: header name: x-auth-org required: false schema: format: RUUID maxLength: 22 minLength: 22 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Occupancysensor_GetMinimalOccupancySensorStatesWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Occupancysensor_GetMinimalOccupancySensorStatesWSResponse" description: OK "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "429": $ref: "#/components/responses/TooManyRequests" "500": $ref: "#/components/responses/InternalServerError" "503": $ref: "#/components/responses/ServiceUnavailable" security: - ApiKeyAuth: [] - oauth2: - read summary: Get minimal occupancy sensor state list tags: - Occupancy Webservice components: schemas: Occupancysensor_GetMinimalOccupancySensorStatesWSRequest: description: Request object for getting minimal occupancy sensor states for all sensors in organization. type: object Occupancysensor_GetMinimalOccupancySensorStatesWSResponse: description: Response object containing minimal occupancy sensor states for all sensors in organization. properties: error: nullable: true type: boolean errorCode: description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg. nullable: true type: string errorMsg: nullable: true type: string occupancySensorStates: description: List of minimal occupancy sensor states items: $ref: "#/components/schemas/Occupancysensor_MinimalOccupancySensorStateType" nullable: true type: array warningMsg: nullable: true type: string type: object Occupancysensor_MinimalOccupancySensorStateType: description: Minimal state information for occupancy sensors including health, location, and sensor data. properties: associatedCameras: description: List of associated camera device facet UUIDs items: description: RUUID with optional appended facet information example: AAAAAAAAAAAAAAAAAAAAAA.v0 format: DeviceFacetUuid nullable: true type: string nullable: true type: array batteryPercent: description: Battery percentage of the sensor example: 85 format: int32 nullable: true type: integer closestBaseStation: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string firmwareVersion: description: Firmware version of the sensor example: 1.2.3 nullable: true type: string floorNumber: description: Floor number where the sensor is located example: 2 format: int32 nullable: true type: integer health: $ref: "#/components/schemas/Occupancysensor_MotionSensorHealthEnum" healthDetails: $ref: "#/components/schemas/Occupancysensor_MotionSensorHealthDetailsEnum" hwVariation: $ref: "#/components/schemas/HardwareVariationEnum" lastSeenSec: description: Timestamp when the sensor was last seen (seconds since epoch) example: 1640995200 format: int64 nullable: true type: integer latitude: description: Latitude coordinate of the sensor location example: 37.7749 format: double nullable: true type: number locationUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string longitude: description: Longitude coordinate of the sensor location example: -122.4194 format: double nullable: true type: number name: description: Name of the occupancy sensor example: Conference Room Sensor nullable: true type: string normalizedLux: description: Normalized lux value (0-1) matching human perception of lighting transitions example: 0.75 format: float nullable: true type: number policyUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string rawLux: description: Raw lux value from the sensor example: 500 format: int32 nullable: true type: integer sensorUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string serialNumber: description: Serial number of the occupancy sensor example: RH123456789 nullable: true type: string signalStrength: description: Signal strength of the sensor example: -45 format: int32 nullable: true type: integer status: $ref: "#/components/schemas/OccupancyStatusEnum" subLocationsHierarchyKey: description: | A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.). example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA format: SubLocationsHierarchyKey nullable: true pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$ type: string type: object Occupancysensor_MotionSensorHealthEnum: description: Motion sensor health status. enum: - RED - GREEN type: string Occupancysensor_MotionSensorHealthDetailsEnum: description: Detailed motion sensor health status. enum: - NO_HEARTBEAT - FIRMWARE_BEHIND - NONE type: string HardwareVariationEnum: enum: - RASPBERRY_PI_3 - CAMERA_R1 - CAMERA_R2 - CAMERA_R2_LONG_RANGE - CAMERA_R2_180 - CAMERA_R3 - CAMERA_R4 - CAMERA_R100 - CAMERA_R120 - CAMERA_R170 - CAMERA_R200 - CAMERA_R500 - CAMERA_R510 - CAMERA_R520 - CAMERA_R600 - SENSOR_ASSET_TAG_T1 - SENSOR_DOOR_D1 - SENSOR_DOOR_D20 - SENSOR_ENVIRONMENTAL_E1 - SENSOR_ENVIRONMENTAL_E15 - SENSOR_ENVIRONMENTAL_E2 - SENSOR_MOTION_M1 - SENSOR_MOTION_M15 - GATEWAY_A1 - GATEWAY_A100 - GATEWAY_ENVIRONMENTAL_E50 - CAMERA_R220 - CAMERA_R230 - CAMERA_R36S - CAMERA_R410 - CAMERA_R540 - CAMERA_R545 - BADGE_READER_DR1 - BADGE_READER_DR40 - BADGE_READER_DR20 - DOOR_CONTROLLER_DC1 - DOOR_CONTROLLER_DC20 - DOOR_CONTROLLER_DC10 - ETHERNET_TESTER_ET1 - IO_BOARD_TB1 - BLE_BUTTON_B10 - BLE_BUTTON_B15 - CAMERA_THIRD_PARTY_RELAY - CAMERA_THIRD_PARTY_NVR - CAMERA_THIRD_PARTY_NVR_MULTISENSOR - NVR_N100 - CAMERA_R130 - NVR_N500 - CAMERA_R150 - ROBOT_RC1 - CAMERA_R210 - CAMERA_R650 - NVR_N550 - NVR_N551 - ROBOT_RC2 - UNSPECIFIED type: string OccupancyStatusEnum: description: Current occupancy status of the sensor enum: - VACANT - MOVEMENT - OCCUPIED type: string securitySchemes: ApiKeyAuth: description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). in: header name: x-auth-apikey type: apiKey oauth2: description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer `. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.' flows: authorizationCode: authorizationUrl: https://console.rhombus.com/oauth/authorize refreshUrl: https://auth-web.rhombussystems.com/oauth/token scopes: physical: Unlock doors and elevators, lockdown, alarms, speakers and robots read: View cameras, footage and settings write: Change settings and data tokenUrl: https://auth-web.rhombussystems.com/oauth/token type: oauth2 ````