Method: domains.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.
HTTP request
GET https://gmailpostmastertools.googleapis.com/v1/domains
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
integer
Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.
|
pageToken |
string
The nextPageToken value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to domains.list method.
|
Request body
The request body must be empty.
Response body
Response message for domains.list.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"domains": [
{
object (Domain)
}
],
"nextPageToken": string
} |
| Fields |
domains[] |
object (Domain)
The list of domains.
|
nextPageToken |
string
Token to retrieve the next page of results, or empty if there are no more results in the list.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/postmaster.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: domains.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.ListDomainsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.\n\n### HTTP request\n\n`GET https://gmailpostmastertools.googleapis.com/v1/domains`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. This is the value of [ListDomainsResponse.next_page_token](/workspace/gmail/postmaster/reference/rest/v1/domains/list#body.ListDomainsResponse.FIELDS.next_page_token) returned from the previous call to `domains.list` method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for domains.list.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"domains\": [ { object (/workspace/gmail/postmaster/reference/rest/v1/domains#Domain) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------|\n| `domains[]` | `object (`[Domain](/workspace/gmail/postmaster/reference/rest/v1/domains#Domain)`)` The list of domains. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/postmaster.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
