Method: alerts.get

Gets the specified alert. Attempting to get a nonexistent alert returns NOT_FOUND error.

HTTP request

GET https://alertcenter.googleapis.com/v1beta1/alerts/{alertId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
alertId

string

Required. The identifier of the alert to retrieve.

Query parameters

Parameters
customerId

string

Optional. The unique identifier of the Google Workspace account of the customer the alert is associated with. The customerId must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Alert.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/apps.alerts

For more information, see the Authorization guide.