View as Markdown
Gmail icon

Gmail ACTION

List Filters

List every filter configured in the authenticated user's Gmail settings, including each filter's id, criteria (what it matches) and action (what it does to matching mail). Call this before Delete Filter to find the id of the filter to remove, or before Create Filter to check whether an equivalent filter already exists. Returns an empty filter list (or no filter key) when the user has no filters. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Gmail account once, then configure and run List Filters from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "gmail-list-filters",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gmail: { authProvisionId: "apn_xxxxxxx" },
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Filters inputs
Property Type Description

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
gmail-list-filters
Version
0.0.1
App
Gmail
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes