Method: users.labels.get
Gets the specified label.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/labels/{id}
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.
|
id |
string
The ID of the label to retrieve.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Label.
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.readonly
https://www.googleapis.com/auth/gmail.labels
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 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Retrieves a specific label using the label ID and user's email address."],["Requires an empty request body and returns a `Label` object upon success."],["Needs authorization with specific OAuth scopes like `https://mail.google.com/` or `https://www.googleapis.com/auth/gmail.readonly`."],["Uses a `GET` request to the URL `https://gmail.googleapis.com/gmail/v1/users/{userId}/labels/{id}` with gRPC Transcoding syntax."]]],["This document details how to retrieve a specific label from Gmail. A `GET` request is sent to `https://gmail.googleapis.com/gmail/v1/users/{userId}/labels/{id}`, where `userId` is the user's email or \"me,\" and `id` is the label's ID. The request body must be empty. A successful response will contain label details, and this requires one of five specified OAuth authorization scopes. The guide also references gRPC Transcoding.\n"]]
