Method: users.getProfile
Stay organized with collections
Save and categorize content based on your preferences.
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
Profile for a Gmail user.
If successful, the response body contains data with the following structure:
| 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 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: users.getProfile\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Profile.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets the current user's Gmail profile.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/profile`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nProfile for a Gmail user.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------|\n| ``` { \"emailAddress\": string, \"messagesTotal\": integer, \"threadsTotal\": integer, \"historyId\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------|\n| `emailAddress` | `string` The user's email address. |\n| `messagesTotal` | `integer` The total number of messages in the mailbox. |\n| `threadsTotal` | `integer` The total number of threads in the mailbox. |\n| `historyId` | `string` The ID of the mailbox's current history record. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.compose`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n- `\n https://www.googleapis.com/auth/gmail.metadata`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
