Users: get

Retrieves a user. Try it now.


HTTP request



Parameter name Value Description
Path parameters
userKey string Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
Optional query parameters
customFieldMask string A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
projection string What subset of fields to fetch for this user.

Acceptable values are:
  • "basic": Do not include any custom fields for the user. (default)
  • "custom": Include custom fields from schemas requested in customFieldMask.
  • "full": Include all fields associated with this user.
viewType string Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see Retrieve a user as a non-administrator.

Acceptable values are:
  • "admin_view": Results include both administrator-only and domain-public fields for the user. (default)
  • "domain_public": Results only include fields for the user that are publicly visible to other users in the domain. Contact sharing must be enabled for the domain.


This request requires authorization with at least one of the following scopes:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


If successful, this method returns a Users resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.