Method: alerts.get
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Method: alerts.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n\nGets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error.\n\n### HTTP request\n\n`GET https://alertcenter.googleapis.com/v1beta1/alerts/{alertId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|-------------------------------------------------------------|\n| `alertId` | `string` Required. The identifier of the alert to retrieve. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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](https://support.google.com/cloudidentity/answer/10070793). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Alert](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts#Alert).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.alerts`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
