
= Notifications

NOTE: The default offset is 0, the default limit is 10 results.
To get all results, use `limit=0` as a parameter on the URL (i.e., `GET /events?limit=0`).

== GETs (reading data)

[caption=]
.Notifications API GET functions
[options="autowidth"]
|===
| Resource  | Description

| /notifications
| Get a list of notifications.

| /notifications/count
| Get the number of notifications (returns plaintext rather than XML or JSON).

| /notifications/\{id}
| Get the notification specified by the given ID.
|===

To acknowledge or unacknowledge a notification, use the `acks` endpoint (see xref:rest/acknowledgements.adoc[]).

== POST (actions)

[caption=]
.Notifications API POST functions
[options="autowidth"]
|===
| Resource  | Description

| "/notifications/destination-paths/\{destinationPathName}/trigger"
| Trigger the destination path's targets and commands with a test notification.
  Use to verify that commands are properly configured and that notifications get sent to the recipients.
|===
