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

GET

users

Lists all labels in the user's mailbox.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gmail.googleapis.com//gmail/v1/users//labels'

Response Example

{
    "labels": [
        {
            "color": {
                "backgroundColor": "string",
                "textColor": "string"
            },
            "id": "string",
            "labelListVisibility": "labelShow",
            "messageListVisibility": "show",
            "messagesTotal": 0,
            "messagesUnread": 0,
            "name": "string",
            "threadsTotal": 0,
            "threadsUnread": 0,
            "type": "system"
        }
    ]
}

Request

Path Params

userId

string

required

The user's email address. The special value me can be used to indicate the authenticated user.

Responses

🟢200Successful response

application/json

Body

labels

array[object (Label) {10}]

optional

List of labels. Note that each label resource only contains an id, name, messageListVisibility, labelListVisibility, and type. The labels.get method can fetch additional label details.

color

object (LabelColor)

optional

The color to assign to the label. Color is only available for labels that have their type set to user.

string

optional

The immutable ID of the label.

labelListVisibility

enum<string>

optional

The visibility of the label in the label list in the Gmail web interface.

Allowed values:

labelShowlabelShowIfUnreadlabelHide

messageListVisibility

enum<string>

optional

The visibility of messages with this label in the message list in the Gmail web interface.

Allowed values:

showhide

messagesTotal

integer <int32>

optional

The total number of messages with the label.

messagesUnread

integer <int32>

optional

The number of unread messages with the label.

name

string

optional

The display name of the label.

threadsTotal

integer <int32>

optional

The total number of threads with the label.

threadsUnread

integer <int32>

optional

The number of unread threads with the label.

type

enum<string>

optional

The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.

Allowed values:

systemuser

/gmail/v1/users/{userId}/history

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