List notification rules

View as Markdown
Returns the board's rules, optionally narrowed to one widget or to enabled rules only.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
board_idstringRequiredformat: "uuid"

Headers

X-API-KeystringRequired
Your workspace API key.

Query parameters

widget_idstring or nullOptionalformat: "uuid"
Return only rules delivering this widget
enabledboolean or nullOptional

Return only enabled (true) or only paused (false) rules

Response

Successful Response
notificationslist of objects
The board's notification rules, most recently created first

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error