Skip to main content
POST
Get minimal state events for environmental gateway

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: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 to retrieve events for an environmental gateway.

createdAfterMs
integer<int64> | null
int64

Timestamp in milliseconds after which events should be retrieved

Example:

1640991600000

createdBeforeMs
integer<int64> | null
int64

Timestamp in milliseconds before which events should be retrieved

Example:

1640995200000

deviceUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

lastEvaluatedKey
string | null
maxPageSize
integer<int32> | null
int32

Maximum number of results to return per page

Example:

50

Response

200 - application/json

OK

Response containing minimal environmental gateway states.

error
boolean | null
errorMsg
string | null
lastEvaluatedKey
string | null
minimalEnvironmentalGatewayStates
object[] | null

List of minimal environmental gateway states

warningMsg
string | null
Last modified on August 3, 2026