Gmail API

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

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

Lists the message filters of a Gmail user.

Request

Path Params

userId

string

required

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

Request samples

Responses

Successful response(200)

Successful response

HTTP Code: 200

Content Type : JSONapplication/json

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.

{
  "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"
    }
  ]
}

Last modified: 2 years ago