Method: users.settings.forwardingAddresses.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the forwarding addresses for the specified account.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userId |
string
User's email address. The special value "me" can be used to indicate the authenticated user.
|
Request body
The request body must be empty.
Response body
Response for the forwardingAddresses.list method.
If successful, the response body contains data with the following structure:
| Fields |
forwardingAddresses[] |
object (ForwardingAddress)
List of addresses that may be used for forwarding.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/gmail.settings.basic
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
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-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# Method: users.settings.forwardingAddresses.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListForwardingAddressesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the forwarding addresses for the specified account.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------|\n| `userId` | `string` User's email address. The special value \"me\" can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse for the forwardingAddresses.list method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"forwardingAddresses\": [ { object (/workspace/gmail/api/reference/rest/v1/users.settings.forwardingAddresses#ForwardingAddress) } ] } ``` |\n\n| Fields ||\n|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forwardingAddresses[]` | `object (`[ForwardingAddress](/workspace/gmail/api/reference/rest/v1/users.settings.forwardingAddresses#ForwardingAddress)`)` List of addresses that may be used for forwarding. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/gmail.settings.basic`\n- `\n https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
