ThingsBoardInstall

Summary

Fetch a paginated, filterable list of alarms

Inputs

• authentication — Authentication method for ThingsBoard (API Key or Username/Password)
• pageSize — Maximum number of alarms returned per page (minimum 1)
• page — Zero‑based page index for pagination
• sortOrder — Sort direction, either ASC or DESC
• searchStatus — Filter alarms by search status (ANY, ACTIVE, CLEARED, ACK, UNACK)
• status — Filter alarms by status (ACTIVE_UNACK, ACTIVE_ACK, CLEARED_UNACK, CLEARED_ACK)
• assigneeId — Filter alarms by assignee user ID
• alarmTextSearch — Case‑insensitive substring filter on alarm type, severity or status
• alarmSortProperty — Property used for sorting alarms (e.g., createdTime, severity)
• startTs — Start timestamp (milliseconds since epoch, UTC) for time‑range filter
• endTs — End timestamp (milliseconds since epoch, UTC) for time‑range filter
• fetchOriginator — Include the alarm's originator entity in the response

Output shape

a paginated list of alarm objects

Results are paged via page and pageSize; optional filters may reduce the set; an empty array is returned when no alarms match

Examples

Example 1: Retrieve all alarms for the tenant, sorted by creation time descending

resource=alarm, operation=getAllAlarms, sortOrder=DESC, alarmSortProperty=createdTime, pageSize=10

Example 2: Search for active alarms within a specific time window

resource=alarm, operation=getAllAlarms, searchStatus=ACTIVE, startTs=1622505600000, endTs=1625097600000, pageSize=20

Links

• n8n community nodes installation guide