Skip to content

List notification groups

Request

Get all notification groups subject to filters.

Security
api_key
Query
notificationGroupIdstring, (uuid)

The ID of the notification group to get.

alertIdstring, (uuid)

The ID of the alert rule a notification group is linked to.

organisationIdstring, (uuid)

The ID of the organisation the notification groups are linked to.

statestring

The state of the notification group.

Enum:"active""deleted"
userIdstring

The ID of a user on whose visibility of the notification groups to filter on.

curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/notification-groups?notificationGroupId=497f6eca-6276-4993-bfeb-53cbbbba6f08&alertId=497f6eca-6276-4993-bfeb-53cbbbba6f08&organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&state=active&userId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
deletedAtstring or null, (date-time)read-only
emailsArray of strings, (email)
idstring or null, (uuid)
namestringrequired
organisationIdstring, (uuid)required
statestring
Enum:"active""deleted"
webhookobject
]
Response
[
  {
    "deletedAt": "2019-08-24T14:15:22Z",
    "emails": [ … ],
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
    "state": "active",
    "webhook": {}
  }
]