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 OAuth 2.0 Overview.