Filter

Represents a user-defined filter for determining which statuses should not be shown to the user.

Example 

{
	"id": "19972",
	"title": "Test filter",
	"context": [
		"home"
	],
	"expires_at": "2022-09-20T17:27:39.296Z",
	"filter_action": "warn",
	"keywords": [
		{
			"id": "1197",
			"keyword": "bad word",
			"whole_word": false
		}
	],
	"statuses": [
		{
			"id": "1",
			"status_id": "109031743575371913"
		}
    ]
}

Attributes

id

Description: The ID of the Filter in the database.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history:
4.0.0 - added

title

Description: A title given by the user to name the filter.
Type: String
Version history:
4.0.0 - added

context

Description: The contexts in which the filter should be applied.
Type: Array of String (Enumerable, anyOf)
home = home timeline and lists
notifications = notifications timeline
public = public timelines
thread = expanded thread of a detailed status
account = when viewing a profile
Version history:
4.0.0 - added

expires_at

Description: When the filter should no longer be applied.
Type: nullable String (Datetime), or null if the filter does not expire
Version history:
4.0.0 - added

filter_action

Description: The action to be taken when a status matches this filter.
Type: String (Enumerable, oneOf)
warn = show a warning that identifies the matching filter by title, and allow the user to expand the filtered status. This is the default (and unknown values should be treated as equivalent to warn).
hide = do not show this status if it is received
blur = hide/blur media attachments with a warning identifying the matching filter by title Version history:
4.0.0 - added
4.4.0 (mastodon API version 5) - added blur value to filter_action attribute

keywords optional

Description: The keywords grouped under this filter. Omitted when part of a FilterResult.
Type: Array of FilterKeyword
Version history:
4.0.0 - added

statuses optional

Description: The statuses grouped under this filter. Omitted when part of a FilterResult.
Type: Array of FilterStatus
Version history:
4.0.0 - added

See also

Implementation guidelines for filters
V1::Filter (for Mastodon 3.5 and earlier)
/api/v2/filters methods
app/serializers/rest/filter_serializer.rb

Last updated · Improve this page