notification.group.list

TR50 Request


                        {
    "cmd": {
        "command": "notification.group.list",
        "params": {
            "offset": 0,
            "limit": 10
        }
    }
}

Request Parameters


Name	Type	Required	Description
offset	Integer		The starting list offset, used for pagination. Defaults to 0 if not specified.
limit	Integer		Limits the number of results returned. Defaults to the maximum configured size.

TR50 Response

If the command is sent successfully a success message and a list of notification group objects is returned. Otherwise, an error and error message will be returned.


                        {
  "cmd": {
    "success": true,
    "params": {
      "count": 42,
      "result": [
        {
          "id": "500000000000000000000001",
          "key": "group1",
          "name": "Group One",
          "desc": "Group One description.",
          "public": true,
          "count": 0,
          "createdBy": "admin@example.com",
          "createdOn": "2014-05-06T18:09:11.019-04:00",
          "updatedBy": "admin@example.com",
          "updatedOn": "2014-05-06T18:09:11.019-04:00"
        },
        ...
      ]
    }
  }
}

Response Parameters


Name	Type	Description
count	Integer	The total number of notification group objects.
result	Array	An array of notification group objects.

Results Array Object


Name	Type	Description
id	String	The object Id of the notification group.
key	String	The key.
name	String	The name.
desc	String	The description.
public	Boolean	If the notification group is public or private.
isMember	Boolean
count	Integer
createdBy	String	The email address of the user who created this notification group.
createdOn	String	The date and time that the group was created.
updatedBy	String	The email address of the user who last updated this group.
updatedOn	String	The date and time that the group was updated.