This documentation covers a Beta version of the Postmaster API.

Method: domains.list

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/v1beta1/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

If successful, the response body contains data with the following structure:

Response message for domains.list.

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 OAuth 2.0 Overview.

Try it!