Method: users.getProfile

Gets the current user's Gmail profile.

HTTP request

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/profile

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

The 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

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

Profile for a Gmail user.

JSON representation
{
  "emailAddress": string,
  "messagesTotal": integer,
  "threadsTotal": integer,
  "historyId": string
}
Fields
emailAddress

string

The user's email address.

messagesTotal

integer

The total number of messages in the mailbox.

threadsTotal

integer

The total number of threads in the mailbox.

historyId

string

The ID of the mailbox's current history record.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.compose
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

For more information, see the OAuth 2.0 Overview.