Gmail API

/gmail/v1/users/{userId}/settings/filters

GET

users

Lists the message filters of a Gmail user.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "filter": [
        {
            "action": {
                "addLabelIds": [
                    "string"
                ],
                "forward": "string",
                "removeLabelIds": [
                    "string"
                ]
            },
            "criteria": {
                "excludeChats": true,
                "from": "string",
                "hasAttachment": true,
                "negatedQuery": "string",
                "query": "string",
                "size": 0,
                "sizeComparison": "unspecified",
                "subject": "string",
                "to": "string"
            },
            "id": "string"
        }
    ]
}

Request

Path Params

userId

string

required

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

Responses

🟢200Successful response

application/json

Body

Response for the ListFilters method.

filter

array[object (Filter) {3}]

optional

List of a user's filters.

action

object (FilterAction)

optional

Action that the filter performs.

criteria

object (FilterCriteria)

optional

Matching criteria for the filter.

string

optional

The server assigned ID of the filter.

/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}

/gmail/v1/users/{userId}/settings/filters