Skip to content

List notification group notification groups

Request

Get all notification groups link subject to filters.

Security
api_key
Query
notificationGroupNotificationGroupIdstring, (uuid)

The ID of the notification group link to get.

parentNotificationGroupIdstring, (uuid)

The ID of the parent notification group to get all nested child IDs.

childNotificationGroupIdstring, (uuid)

The ID of the child notification group to get all ancestral IDs.

organisationIdstring, (uuid)

The ID of the organisation the notification group links are linked to.

statestring

The state of the notification group notification group link.

Enum:"active""deleted"
curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/notification-group-notification-groups?notificationGroupNotificationGroupId=497f6eca-6276-4993-bfeb-53cbbbba6f08&parentNotificationGroupId=497f6eca-6276-4993-bfeb-53cbbbba6f08&childNotificationGroupId=497f6eca-6276-4993-bfeb-53cbbbba6f08&organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&state=active' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
childIdstring, (uuid)required
deletedAtstring or null, (date-time)read-only
idstring or null, (uuid)
organisationIdstring, (uuid)required
parentIdstring, (uuid)required
statestring
Enum:"active""deleted"
]
Response
[
  {
    "childId": "da54978f-5a21-4efd-948e-3959f61b037a",
    "deletedAt": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
    "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
    "state": "active"
  }
]