HomepageSponsorsApps

filters

Create and manage filters.

View all filters

GET https://mastodon.example/api/v1/filters

Returns: Filter OAuth: User token + read:filters Version history: 2.4.3 - added

Headers

Name
Type
Description

Authorization

string

Bearer <user token>

[
  {
    "id": "6191",
    "phrase": ":eurovision2019:",
    "context": [
      "home"
    ],
    "whole_word": true,
    "expires_at": "2019-05-21T13:47:31.333Z",
    "irreversible": false
  },
  ...
  {
    "id": "5580",
    "phrase": "@twitter.com",
    "context": [
      "home",
      "notifications",
      "public",
      "thread"
    ],
    "whole_word": false,
    "expires_at": null,
    "irreversible": true
  },
  ...
]

View a single filter

GET https://mastodon.example/api/v1/filters/:id

Returns: Filter OAuth: User token + read:filters Version history: 2.4.3 - added

Path Parameters

Name
Type
Description

:id

string

Headers

Name
Type
Description

Authorization

string

Bearer <user token>

{
  "id": "8449",
  "phrase": "test",
  "context": [
    "home",
    "notifications",
    "public",
    "thread"
  ],
  "whole_word": false,
  "expires_at": "2019-11-26T09:08:06.254Z",
  "irreversible": true
}

Create a filter

POST https://mastodon.example/api/v1/filters

Returns: Filter OAuth: User token + write:filters Version history: 2.4.3 - added

Headers

Name
Type
Description

Authorization

string

Bearer <user token>

Request Body

Name
Type
Description

phrase

string

Text to be filtered

context

array

Array of enumerable strings home, notifications, public, thread. At least one context must be specified.

irreversible

boolean

Should the server irreversibly drop matching entities from home and notifications?

whole_word

boolean

Consider word boundaries?

expires_in

string

ISO 8601 Datetime for when the filter expires. Otherwise, null for a filter that doesn't expire.

{
  "id": "8449",
  "phrase": "test",
  "context": [
    "home",
    "notifications",
    "public",
    "thread"
  ],
  "whole_word": false,
  "expires_at": "2019-11-26T09:08:06.254Z",
  "irreversible": true
}

Update a filter

PUT https://mastodon.example/api/v1/filters/:id

Returns: Filter OAuth: User token + write:filters Version history: 2.4.3 - added

Path Parameters

Name
Type
Description

id

string

ID of the filter in the database

Headers

Name
Type
Description

Authorization

string

Bearer <user token>

Request Body

Name
Type
Description

phrase

string

Text to be filtered

context

array

Array of enumerable strings home, notifications, public, thread. At least one context must be specified.

irreversible

boolean

Should the server irreversibly drop matching entities from home and notifications?

whole_word

boolean

Consider word boundaries?

expires_in

string

ISO 8601 Datetime for when the filter expires. Otherwise, null for a filter that doesn't expire.

{
  "id": "8449",
  "phrase": "test",
  "context": [
    "home",
    "notifications",
    "public",
    "thread"
  ],
  "whole_word": false,
  "expires_at": null,
  "irreversible": true
}

Remove a filter

DELETE https://mastodon.example/api/v1/filters/:id

Returns: Filter OAuth: User token + write:filters Version history: 2.4.3 - added

Path Parameters

Name
Type
Description

id

string

ID of the filter in the database

Headers

Name
Type
Description

Authorization

string

Bearer <user token>

{}
Previousdomain_blocksNextreports

Last updated

Was this helpful?