Skip to main content

spo site alert list

Lists all SharePoint list alerts

Usage​

m365 spo site alert list [options]

Options​

-u, --webUrl <webUrl>

The URL of the SharePoint site.

--listId [listId]

The ID of the SharePoint list. Specify either listId, listUrl, or listTitle, but not more than one.

--listUrl [listUrl]

The URL of the SharePoint list. Specify either listId, listUrl, or listTitle, but not more than one.

--listTitle [listTitle]

The title of the SharePoint list. Specify either listId, listUrl, or listTitle, but not more than one.

--userName [userName]

The user name to filter alerts for. Specify either userName or userId, but not both.

--userId [userId]

The user ID to filter alerts for. Specify either userName or userId, but not both.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Permissions​

ResourcePermissions
SharePointAllSites.FullControl

Examples​

List all alerts for a SharePoint site:

m365 spo site alert list --webUrl https://contoso.sharepoint.com/sites/Marketing

List alerts for a SharePoint list by listUrl:

m365 spo site alert list --webUrl https://contoso.sharepoint.com/sites/Marketing --listUrl /sites/Marketing/lists/Tasks

List alerts for a specific user by userId:

m365 spo site alert list --webUrl https://contoso.sharepoint.com/sites/Marketing --userId 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e

List alerts for a specific list by title and user by username:

m365 spo site alert list --webUrl https://contoso.sharepoint.com/sites/Marketing --listTitle "Tasks" --userName jane.doe@contoso.com

Response​

[
  {
    "AlertFrequency": 0,
    "AlertTemplateName": "SPAlertTemplateType.DocumentLibrary",
    "AlertType": 1,
    "AlwaysNotify": false,
    "DeliveryChannels": 1,
    "EventType": -1,
    "Filter": "",
    "ID": "c52b4bf0-add0-4323-b670-f765bb46337b",
    "Properties": [
      {
        "Key": "dispformurl",
        "Value": "Shared Documents/Forms/DispForm.aspx",
        "ValueType": "Edm.String"
      }
    ],
    "Status": 0,
    "Title": "Documents: ProjectPlan.docx",
    "UserId": 9,
    "Item": {
      "Id": 37326,
      "FileRef": "/sites/marketing/Shared Documents/ProjectPlan.docx",
      "GUID": "ef5cc60b-71c0-4357-a291-14274234efde"
    },
    "List": {
      "Id": "6b4f195c-02da-47f4-8237-065b96258cf3",
      "Title": "Documents",
      "RootFolder": {
        "ServerRelativeUrl": "/sites/marketing/Shared Documents"
      }
    },
    "User": {
      "Id": 9,
      "IsHiddenInUI": false,
      "LoginName": "i:0#.f|membership|jane.doe@contoso.onmicrosoft.com",
      "Title": "Jane Doe",
      "PrincipalType": 1,
      "Email": "jane.doe@contoso.onmicrosoft.com",
      "Expiration": "",
      "IsEmailAuthenticationGuestUser": false,
      "IsShareByEmailGuestUser": false,
      "IsSiteAdmin": false,
      "UserId": {
        "NameId": "10037ffeaed549a5",
        "NameIdIssuer": "urn:federation:microsoftonline"
      },
      "UserPrincipalName": "jane.doe@contoso.onmicrosoft.com"
    }
  }
]