Method: alerts.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://alertcenter.googleapis.com/v1beta1/alerts
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
customerId |
string
Optional. The unique identifier of the Google Workspace account of the customer the alerts are 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.
|
pageSize |
integer
Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
|
pageToken |
string
Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's nextPageToken field.
|
filter |
string
Optional. A query string for filtering alert results. For more details, see Query filters and Supported query filter fields.
|
orderBy |
string
Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using orderBy="createTime desc". Currently, supported sorting are createTime asc, createTime desc, updateTime desc
|
Request body
The request body must be empty.
Response body
Response message for an alert listing request.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"alerts": [
{
object (Alert)
}
],
"nextPageToken": string
} |
| Fields |
alerts[] |
object (Alert)
The list of alerts.
|
nextPageToken |
string
The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call.
|
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.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAlertsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n\nLists the alerts.\n\n### HTTP request\n\n`GET https://alertcenter.googleapis.com/v1beta1/alerts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` Optional. The unique identifier of the Google Workspace account of the customer the alerts are 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| `pageSize` | `integer` Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default. |\n| `pageToken` | `string` Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's [nextPageToken](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts/list#body.ListAlertsResponse.FIELDS.next_page_token) field. |\n| `filter` | `string` Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/workspace/admin/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/workspace/admin/alertcenter/reference/filter-fields#alerts.list). |\n| `orderBy` | `string` Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `orderBy=\"createTime desc\"`. Currently, supported sorting are `createTime asc`, `createTime desc`, `updateTime desc` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for an alert listing request.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"alerts\": [ { object (/workspace/admin/alertcenter/reference/rest/v1beta1/alerts#Alert) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `alerts[]` | `object (`[Alert](/workspace/admin/alertcenter/reference/rest/v1beta1/alerts#Alert)`)` The list of alerts. |\n| `nextPageToken` | `string` The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent `ListAlertsRequest` to get alerts continuing from last result of the current list call. |\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)."]]
