pnp/cli-microsoft365

New command: `spo web alert get`

Open

#6,862 opened on Aug 26, 2025

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (399 forks)auto 404
good first issuehelp wantednew feature

Repository metrics

Stars
 (1,390 stars)
PR merge metrics
 (PR metrics pending)

Description

Usage

m365 spo web alert get [options]

Description

Retrieves details of a specific alert from a SharePoint site list

Options

Option Description
-u, --webUrl <webUrl> The URL of the SharePoint site.
--id <id> The ID of the alert.

Examples

Get details of an alert by ID:

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

Default properties

No response

Additional Info

API request

GET https://contoso.sharepoint.com/sites/Marketing/_api/Web/Alerts/GetById('<alert id>')?$expand=List,User,List/Rootfolder&$select=*,List/Id,List/Title,List/Rootfolder/ServerRelativeUrl

Contributor guide

Research direction
Study the existing command 'spo web alert list' to understand the command structure. Then create a new command file for 'spo web alert get' that makes a GET request to the SharePoint REST API endpoint / api/Web/Alerts/GetById('<id>') with query parameters to expand list, user, and root folder. Handle options webUrl and id. Register the command in the command registry. Write unit tests mimicking the pattern of existing tests. Finally, update documentation.
Tech stack
typescript
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75