Skip to content

Google: Gets a filter For more information, see Manage Gmail filters (https: developers google com workspace gmail api guides filter settings) — response body — action

Gets a filter. For more information, see [Manage Gmail filters](https://developers.google.com/workspace/gmail/api/guides/filter_settings).: response body, field action. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Gets a filter For more information, see Manage Gmail filters (https: developers google com workspace gmail api guides filter settings) — response body — action

FieldTypePresenceDescription and constraints
$objectRootA set of actions to perform on a message.
addLabelIdsarrayOptionalList of labels to add to the message.
addLabelIds[]stringEach item
forwardstringOptionalEmail address that the message should be forwarded to. This effectively redirects the message to the address specified in this field, maintaining the original sender in the “From” field.
removeLabelIdsarrayOptionalList of labels to remove from the message.
removeLabelIds[]stringEach item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.