Blocks, mutes & filters

GET/api/v1/blocks

List blocked accounts

Mastodon compatible User token Scope read

Query parameters

limitinteger

pageinteger

Returns

curl "https://pixelfed.social/api/v1/blocks?limit=40" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/blocks?limit=40", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const accounts = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/blocks",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    params={
        "limit": 40,
    },
)

accounts = res.json()

use Illuminate\Support\Facades\Http;

$accounts = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/blocks', [
        'limit' => 40,
    ])
    ->json();

Response

[{
  "id": "412760184563377",
  "username": "jonas",
  "acct": "jonas",
  "display_name": "Jonas",
  "discoverable": true,
  "locked": false,
  "followers_count": 88,
  "following_count": 140,
  "statuses_count": 37,
  "note": "",
  "note_text": null,
  "url": "https://pixelfed.social/jonas",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/377/avatar.jpg",
  "website": null,
  "local": true,
  "is_admin": false,
  "created_at": "2025-01-19T10:12:40.000000Z",
  "header_bg": null,
  "last_fetched_at": null,
  "pronouns": [],
  "location": null,
  "has_story": false
}]

{
  "error": "Unauthenticated."
}

GET/api/v1/mutes

List muted accounts

Mastodon compatible User token Scope read

Query parameters

limitinteger

pageinteger

Returns

curl "https://pixelfed.social/api/v1/mutes?limit=40" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/mutes?limit=40", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const accounts = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/mutes",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    params={
        "limit": 40,
    },
)

accounts = res.json()

use Illuminate\Support\Facades\Http;

$accounts = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/mutes', [
        'limit' => 40,
    ])
    ->json();

Response

[{
  "id": "412760184563377",
  "username": "jonas",
  "acct": "jonas",
  "display_name": "Jonas",
  "locked": false,
  "followers_count": 88,
  "following_count": 140,
  "statuses_count": 37,
  "url": "https://pixelfed.social/jonas",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/377/avatar.jpg",
  "local": true,
  "created_at": "2025-01-19T10:12:40.000000Z"
}]

{
  "error": "Unauthenticated."
}

GET/api/v1/domain_blocks

List blocked domains

Mastodon compatible User token

Query parameters

limitinteger

cursorstring

Returns

curl "https://pixelfed.social/api/v1/domain_blocks?limit=100" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/domain_blocks?limit=100", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const domains = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/domain_blocks",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    params={
        "limit": 100,
    },
)

domains = res.json()

use Illuminate\Support\Facades\Http;

$domains = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/domain_blocks', [
        'limit' => 100,
    ])
    ->json();

Response

["spam.example", "ads.example"]

{
  "message": "The limit field must not be greater than 200.",
  "errors": {
    "limit": ["The limit field must not be greater than 200."]
  }
}

POST/api/v1/domain_blocks

Block a domain

Mastodon compatible User token

Body parameters

domainstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/domain_blocks" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "https://spam.example"
  }'

const res = await fetch("https://pixelfed.social/api/v1/domain_blocks", {
  method: "POST",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    domain: "https://spam.example",
  }),
});

const res = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1/domain_blocks",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "domain": "https://spam.example",
    },
)

res = res.json()

use Illuminate\Support\Facades\Http;

$res = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/domain_blocks', [
        'domain' => 'https://spam.example',
    ])
    ->json();

Response

[]

{
  "error": "Max limit of domain blocks reached! You can only block 100 domains at a time. Ask your admin to adjust this limit."
}

{
  "error": "Invalid domain or already blocked by server admins"
}

DELETE/api/v1/domain_blocks

Unblock a domain

Mastodon compatible User token

Body parameters

domainstringrequired

Returns

curl -X DELETE "https://pixelfed.social/api/v1/domain_blocks" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "spam.example"
  }'

const res = await fetch("https://pixelfed.social/api/v1/domain_blocks", {
  method: "DELETE",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    domain: "spam.example",
  }),
});

const res = await res.json();

import requests

res = requests.delete(
    "https://pixelfed.social/api/v1/domain_blocks",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "domain": "spam.example",
    },
)

res = res.json()

use Illuminate\Support\Facades\Http;

$res = Http::acceptJson()
    ->withToken($token)
    ->delete('https://pixelfed.social/api/v1/domain_blocks', [
        'domain' => 'spam.example',
    ])
    ->json();

Response

[]

{
  "message": "The domain field is required.",
  "errors": {
    "domain": ["The domain field is required."]
  }
}

GET/api/v1/filters

List filters (v1)

Mastodon compatible User token Scope read

Returns

curl "https://pixelfed.social/api/v1/filters" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/filters", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const filters = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/filters",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

filters = res.json()

use Illuminate\Support\Facades\Http;

$filters = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/filters')
    ->json();

Response

[]

{
  "error": "Unauthenticated."
}

GET/api/v2/filters

List filters

Mastodon compatible User token Scope read

Returns

curl "https://pixelfed.social/api/v2/filters" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v2/filters", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const filters = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v2/filters",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

filters = res.json()

use Illuminate\Support\Facades\Http;

$filters = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v2/filters')
    ->json();

Response

[{
  "id": "29",
  "title": "Spoilers",
  "context": ["home", "public"],
  "expires_at": null,
  "filter_action": "warn",
  "keywords": [{
    "id": 71,
    "keyword": "season finale",
    "whole_word": true
  }],
  "statuses": []
}]

{
  "error": "Unauthenticated."
}

GET/api/v2/filters/{id}

Get a filter

Mastodon compatible User token Scope read

Path parameters

idstringrequired

Returns

curl "https://pixelfed.social/api/v2/filters/29" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v2/filters/29", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const filter = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v2/filters/29",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

filter = res.json()

use Illuminate\Support\Facades\Http;

$filter = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v2/filters/29')
    ->json();

Response

{
  "id": "29",
  "title": "Spoilers",
  "context": ["home", "public"],
  "expires_at": null,
  "filter_action": "warn",
  "keywords": [{
    "id": 71,
    "keyword": "season finale",
    "whole_word": true
  }],
  "statuses": []
}

{
  "error": "This action is unauthorized."
}

{
  "error": "No query results for model [App\\Models\\CustomFilter] 29"
}

POST/api/v2/filters

Create a filter

Mastodon compatible User token Scope write

Body parameters

titlestringrequired

context[]array of stringsrequired

filter_actionstring

expires_ininteger

keywords_attributes[][keyword]stringrequired

keywords_attributes[][whole_word]boolean

Returns

curl -X POST "https://pixelfed.social/api/v2/filters" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Spoilers",
    "context": ["home", "public"],
    "filter_action": "warn",
    "keywords_attributes": [{
      "keyword": "season finale",
      "whole_word": true
    }]
  }'

const res = await fetch("https://pixelfed.social/api/v2/filters", {
  method: "POST",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    title: "Spoilers",
    context: ["home", "public"],
    filter_action: "warn",
    keywords_attributes: [{
      keyword: "season finale",
      whole_word: true,
    }],
  }),
});

const filter = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v2/filters",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "title": "Spoilers",
        "context": ["home", "public"],
        "filter_action": "warn",
        "keywords_attributes": [{
            "keyword": "season finale",
            "whole_word": True,
        }],
    },
)

filter = res.json()

use Illuminate\Support\Facades\Http;

$filter = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v2/filters', [
        'title' => 'Spoilers',
        'context' => ['home', 'public'],
        'filter_action' => 'warn',
        'keywords_attributes' => [[
            'keyword' => 'season finale',
            'whole_word' => true,
        ]],
    ])
    ->json();

Response

{
  "id": "29",
  "title": "Spoilers",
  "context": ["home", "public"],
  "expires_at": null,
  "filter_action": "warn",
  "keywords": [{
    "id": 71,
    "keyword": "season finale",
    "whole_word": true
  }],
  "statuses": []
}

{
  "error": "Duplicate keywords found",
  "message": "The following keywords already exist: season finale"
}

{
  "error": "Rate limit exceeded",
  "message": "You can only create 20 filters per hour."
}

PUT/api/v2/filters/{id}

Update a filter

Mastodon compatible User token Scope write

Path parameters

idstringrequired

Body parameters

titlestring

context[]array of strings

filter_actionstring

expires_ininteger

keywords_attributes[][id]integer

keywords_attributes[][keyword]stringrequired

keywords_attributes[][whole_word]boolean

keywords_attributes[][_destroy]boolean

Returns

curl -X PUT "https://pixelfed.social/api/v2/filters/29" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter_action": "hide",
    "keywords_attributes": [{
      "id": 71,
      "_destroy": true
    }, {
      "keyword": "finale"
    }]
  }'

const res = await fetch("https://pixelfed.social/api/v2/filters/29", {
  method: "PUT",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    filter_action: "hide",
    keywords_attributes: [{
      id: 71,
      _destroy: true,
    }, {
      keyword: "finale",
    }],
  }),
});

const filter = await res.json();

import requests

res = requests.put(
    "https://pixelfed.social/api/v2/filters/29",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "filter_action": "hide",
        "keywords_attributes": [{
            "id": 71,
            "_destroy": True,
        }, {
            "keyword": "finale",
        }],
    },
)

filter = res.json()

use Illuminate\Support\Facades\Http;

$filter = Http::acceptJson()
    ->withToken($token)
    ->put('https://pixelfed.social/api/v2/filters/29', [
        'filter_action' => 'hide',
        'keywords_attributes' => [[
            'id' => 71,
            '_destroy' => true,
        ], [
            'keyword' => 'finale',
        ]],
    ])
    ->json();

Response

{
  "id": "29",
  "title": "Spoilers",
  "context": ["home", "public"],
  "expires_at": null,
  "filter_action": "hide",
  "keywords": [{
    "id": 74,
    "keyword": "finale",
    "whole_word": true
  }],
  "statuses": []
}

{
  "error": "This action is unauthorized"
}

{
  "message": "The keywords attributes field is required.",
  "errors": {
    "keywords_attributes": ["The keywords attributes field is required."]
  }
}

DELETE/api/v2/filters/{id}

Delete a filter

Mastodon compatible User token Scope write

Path parameters

idstringrequired

Returns

curl -X DELETE "https://pixelfed.social/api/v2/filters/29" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v2/filters/29", {
  method: "DELETE",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const res = await res.json();

import requests

res = requests.delete(
    "https://pixelfed.social/api/v2/filters/29",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
)

res = res.json()

use Illuminate\Support\Facades\Http;

$res = Http::acceptJson()
    ->withToken($token)
    ->delete('https://pixelfed.social/api/v2/filters/29')
    ->json();

Response

{}

{
  "error": "This action is unauthorized."
}

{
  "error": "No query results for model [App\\Models\\CustomFilter] 29"
}

POST/api/v1.1/report

Report content

Pixelfed only User token Scope write

Body parameters

object_typestringrequired

object_idstringrequired

report_typestringrequired

messagestring

Returns

curl -X POST "https://pixelfed.social/api/v1.1/report" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "object_type": "post",
    "object_id": "728355012774117376",
    "report_type": "spam",
    "message": "Same link posted under every hashtag"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/report", {
  method: "POST",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    object_type: "post",
    object_id: "728355012774117376",
    report_type: "spam",
    message: "Same link posted under every hashtag",
  }),
});

const report = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/report",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "object_type": "post",
        "object_id": "728355012774117376",
        "report_type": "spam",
        "message": "Same link posted under every hashtag",
    },
)

report = res.json()

use Illuminate\Support\Facades\Http;

$report = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1.1/report', [
        'object_type' => 'post',
        'object_id' => '728355012774117376',
        'report_type' => 'spam',
        'message' => 'Same link posted under every hashtag',
    ])
    ->json();

Response

{
  "msg": "Successfully sent report",
  "code": 200
}

{
  "msg": "Duplicate report",
  "code": 400,
  "error_code": "ERROR_REPORT_DUPLICATE"
}

{
  "msg": "Invalid or missing parameters",
  "code": 400,
  "error_code": "ERROR_INVALID_PARAMS"
}

Pixelfed is free and open source software. Edit this page Report a docs issue