gmail.users.labels.get

GET /gmail/v1/users/{userId}/labels/{id}

Copy endpoint

https://gmail.googleapis.com/

Gets the specified label.

Parameters

path Path Parameters

Name	Type
`userId` required The user's email address. The special value `me` can be used to indicate the authenticated user.	string
`id` required The ID of the label to retrieve.	string

query Query Parameters

Name	Type
`fields` Selector specifying which fields to include in a partial response.	string
`upload_protocol` Upload protocol for media (e.g. "raw", "multipart").	string
`uploadType` Legacy upload protocol for media (e.g. "media", "multipart").	string
`$.xgafv` V1 error format.	"1" \| "2"
`oauth_token` OAuth 2.0 token for the current user.	string
`prettyPrint` Returns response with indentations and line breaks.	boolean
`quotaUser` Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.	string
`access_token` OAuth access token.	string
`callback` JSONP	string
`key` API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.	string
`alt` Data format for response.	"json" \| "media" \| "proto"

Responses

200 */*

Successful response

interface Label {
color?:

LabelColor

interface LabelColor {
backgroundColor?: string;
textColor?: string;
}

;
id?: string;
labelListVisibility?: "labelShow" | "labelShowIfUnread" | "labelHide";
messageListVisibility?: "show" | "hide";
messagesTotal?: number;
messagesUnread?: number;
name?: string;
threadsTotal?: number;
threadsUnread?: number;
type?: "system" | "user";
}