Method: users.settings.filters.list

Lists the message filters of a Gmail user.

HTTP request

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/filters

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

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

Request body

The request body must be empty.

Response body

Response for the filters.list method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "filter": [
    {
      object (Filter)
    }
  ]
}
Fields
filter[]

object (Filter)

List of a user's filters.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly

For more information, see the Authorization guide.