Gmail.users.labels.list

Lists all labels in the user's mailbox.

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

Use it in a workflow

Add a step and choose the Gmail connector.
Pick the Gmail.users.labels.list action (under users).
Fill in the fields below, then reference the result from later steps as {{gmailUsersLabelsList.response.data}}.

Request

Path parameters

userIdstringrequired

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

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

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.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

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.

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

Response

Returns 200 with an object. Read it in later steps with {{gmailUsersLabelsList.response.data.<field>}}.

labelsarray<object>

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.

colorobject2 fields

idstring

The immutable ID of the label.

labelListVisibilitystring

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

One oflabelShowlabelShowIfUnreadlabelHide

messageListVisibilitystring

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

One ofshowhide

messagesTotalinteger (int32)

The total number of messages with the label.

messagesUnreadinteger (int32)

The number of unread messages with the label.

namestring

The display name of the label.

threadsTotalinteger (int32)

The total number of threads with the label.

threadsUnreadinteger (int32)

The number of unread threads with the label.

typestring

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.

One ofsystemuser

json

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

Need more? See the Gmail guide for connection setup and behaviour shared by every action.

Was this page helpful?