Users.settings.filters: list

Lists the message filters of a Gmail user. Try it now.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
userId string User's email address. The special value "me" can be used to indicate the authenticated user.

Authorization

This request requires authorization with at least one of the following scopes:

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

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "filter": [
    users.settings.filters Resource
  ]
}
Property name Value Description Notes
filter[] list List of a user's filters.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Need help? Visit our support page.