---
updatedAt: 2025-12-04T23:37:15.000Z
---

# List Notification Groups

Returns all Notification Groups that match specified criteria. Filters by name or Id. 

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "LogRhythm Admin Service API",
    "version": "9.175.0",
    "description": "This file describes the available endpoints for administering a LogRhythm deployment. For more information about tokens, security, and registering third party applications, see the documentation available at https://docs.logrhythm.com/docs/lrapi/administration-api."
  },
  "tags": [
    {
      "name": "notification groups",
      "description": "Notification Groups are used to specify the information included in Alarm Notifications sent to people and groups, as well as the frequency of notifications."
    }
  ],
  "x-tagGroups": [
    {
      "name": "Administration",
      "tags": [
        "lists",
        "identities",
        "identity lists",
        "entities",
        "hosts",
        "networks",
        "license",
        "users",
        "notification groups",
        "logsources",
        "agents",
        "beats",
        "openCollectors"
      ]
    },
    {
      "name": "knowledgebase",
      "tags": [
        "locations",
        "logSourceTypes",
        "mpePolicies",
        "messagesourcedateformats",
        "lsvtemplates",
        "mperules",
        "knowledgebase"
      ]
    }
  ],
  "paths": {
    "/notification-groups": {
      "x-swagger-router-controller": "distributions",
      "get": {
        "tags": [
          "notification groups"
        ],
        "summary": "List Notification Groups",
        "description": "Returns all Notification Groups that match specified criteria. Filters by name or Id. ",
        "parameters": [
          {
            "$ref": "#/components/parameters/offset"
          },
          {
            "$ref": "#/components/parameters/count"
          },
          {
            "$ref": "#/components/parameters/dir"
          },
          {
            "$ref": "#/components/parameters/notificationOrderByFilter"
          },
          {
            "$ref": "#/components/parameters/nameFilter"
          },
          {
            "$ref": "#/components/parameters/notificationGroupIdsFilter"
          }
        ],
        "operationId": "listNotificationGroups",
        "security": [
          {
            "Bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "Returns available Notification Groups based on specified filter criteria.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AlarmNfnGroup"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://localhost:8501/lr-admin-api",
      "description": "Local API Gateway (https)"
    }
  ],
  "components": {
    "parameters": {
      "offset": {
        "name": "offset",
        "in": "query",
        "required": false,
        "description": "The starting point of records to be returned.",
        "schema": {
          "type": "integer",
          "default": 0
        }
      },
      "count": {
        "name": "count",
        "in": "query",
        "required": false,
        "description": "The number of results to be returned.",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000,
          "default": 100
        }
      },
      "dir": {
        "name": "dir",
        "in": "query",
        "required": false,
        "description": "Sorts records by ascending or descending.",
        "schema": {
          "type": "string",
          "enum": [
            "ascending",
            "descending"
          ],
          "default": "ascending"
        }
      },
      "nameFilter": {
        "name": "name",
        "in": "query",
        "required": false,
        "description": "Object name filter.",
        "schema": {
          "type": "string"
        }
      },
      "notificationOrderByFilter": {
        "name": "orderBy",
        "description": "Sorts records by notification name or Id.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "name",
            "id"
          ],
          "default": "name"
        }
      },
      "notificationGroupIdsFilter": {
        "name": "id",
        "description": "Filters records by Notification Id.",
        "in": "query",
        "required": false,
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "Authenticate using a JSON Web Token (JWT)."
      }
    },
    "schemas": {
      "recordStatusName": {
        "type": "string",
        "description": "The database status. Required for PUT operations. Valid values are \"Active\" or \"Retired\".",
        "enum": [
          "Retired",
          "Active"
        ],
        "x-omitempty": true
      },
      "AlarmNfnGroup": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/AlarmNfnGroupSummary"
          }
        ],
        "required": [
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The Notification Group Id stored in the system."
          },
          "dateUpdated": {
            "type": "string",
            "format": "date-time",
            "description": "The date when the Notification Group was modified. Shows creation date if recently created.",
            "x-omitempty": true
          },
          "recordStatusName": {
            "$ref": "#/components/schemas/recordStatusName"
          },
          "totalUsers": {
            "type": "integer",
            "description": "The number of Users associated with a group.",
            "x-omitempty": true
          }
        }
      },
      "AlarmNfnGroupSummary": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The Notification Group name.",
            "maxLength": 50
          },
          "shortDescription": {
            "type": "string",
            "description": "A short description of the Notification Group.",
            "maxLength": 255,
            "x-omitempty": true
          },
          "longDescription": {
            "type": "string",
            "description": "A detailed description of the Notification Group.",
            "maxLength": 2000,
            "x-omitempty": true
          }
        }
      }
    }
  }
}
```