Method: domainAliases.get

Retrieves a domain alias of the customer.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. You must provide either the customer or the domain parameter.



Name of domain alias to be retrieved.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of DomainAlias.

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authorization guide.