List labels

listLabels returns every system and user label in the connected Gmail mailbox. Use it to discover immutable label IDs before searching, modifying, updating, or deleting labels.

Example

automations/list-gmail-labels.automation.ts

import { automation } from "automate.ax"
import { listLabels } from "automate.ax/gmail"

export default automation("List Gmail labels", () => {
  listLabels({})
})

Inputs

Property	Type	Required	Description
`account`	`string \| IntegrationAccountReference<"google">`	No	Google account binding to use. Defaults to the project’s default Google account binding.

The account can also be supplied by a compatible Signal.

Output

Returns a Signal<GmailLabel[]>. Each label contains:

interface GmailLabel {
  labelId: string
  name: string
  type?: "system" | "user"
  labelListVisibility?: "labelHide" | "labelShow" | "labelShowIfUnread"
  messageListVisibility?: "hide" | "show"
  color?: {
    backgroundColor: string
    textColor: string
  }
  messagesTotal?: number
  messagesUnread?: number
  threadsTotal?: number
  threadsUnread?: number
}

Gmail does not supply every optional field for every label. For example, system labels and user labels can expose different visibility, color, and count metadata.

Use labelId for durable references and for labelIds search filters. Display names are intended for people and can be renamed.

⌘I

Get started

Concepts

Reference

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output