Skip to main content
POST
Get the current and planned user notification snooze details

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 object for retrieving current and planned user notification snooze details.

Response

200 - application/json

OK

Response object containing current and planned user notification snooze details.

error
boolean | null
errorMsg
string | null
snoozedForAllNotificationsIntervals
object[] | null

List of intervals when all notifications are snoozed

snoozedForComponentCompositesMap
object | null

Map of component composite UUIDs to their snooze notification intervals

snoozedForDevicesMap
object | null

Map of device UUIDs to their snooze notification intervals

snoozedForLocationsMap
object | null

Map of location UUIDs to their snooze notification intervals

warningMsg
string | null
Last modified on August 7, 2026