documentation/content/en/entities/FilterStatus.md

1.1 KiB

title description menu aliases
FilterStatus Represents a status ID that, if matched, should cause the filter action to be taken.
docs
parent
entities
/entities/filterstatus
/entities/FilterStatus
/api/entities/filterstatus
/api/entities/FilterStatus

Example

{
	"id": "1",
	"status_id": "109031743575371913"
}

Attributes

id

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

status_id

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

See also

{{< page-relref ref="api/guidelines#filters" caption="Implementation guidelines for filters" >}}

{{< page-relref ref="methods/filters" caption="/api/v2/filters methods" >}}

{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/filter_status_serializer.rb" caption="app/serializers/rest/filter_status_serializer.rb" >}}