Accounts

GET/api/v1/accounts/verify_credentials

Verify credentials

Mastodon compatible Supports _pe User token Scope read

Query parameters

_peboolean

Returns

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

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

const account = await res.json();

import requests

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

account = res.json()

use Illuminate\Support\Facades\Http;

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

Response

{
  "id": "2",
  "username": "dansup",
  "acct": "dansup",
  "display_name": "dansup",
  "discoverable": true,
  "locked": false,
  "followers_count": 1284,
  "following_count": 312,
  "statuses_count": 468,
  "note": "Pixelfed developer",
  "url": "https://pixelfed.social/dansup",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "avatar_static": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "header": "https://pixelfed.social/storage/headers/missing.png",
  "header_static": "https://pixelfed.social/storage/headers/missing.png",
  "bot": false,
  "emojis": [],
  "fields": [],
  "last_status_at": null,
  "created_at": "2019-03-02T18:21:07.000000Z",
  "source": {
    "privacy": "public",
    "sensitive": false,
    "language": "en",
    "note": "Pixelfed developer",
    "fields": []
  }
}

{
  "error": "Unauthenticated."
}

PATCH/api/v1/accounts/update_credentials

Update profile

Mastodon compatible Supports _pe User token Scope write

Query parameters

_peboolean

Body parameters

display_namestring

notestring

avatarfile

lockedboolean

websitestring

source[privacy]string

source[language]string

licenseinteger

sync_licensesboolean

media_descriptionsboolean

crawlableboolean

is_suggestableboolean

show_profile_follower_countboolean

show_profile_following_countboolean

public_dmboolean

disable_embedsboolean

show_atomboolean

reduce_motionboolean

high_contrast_modeboolean

video_autoplayboolean

Returns

curl -X PATCH "https://pixelfed.social/api/v1/accounts/update_credentials" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "dansup",
    "note": "Film and fog, mostly. Tallinn and the Baltic coast.",
    "locked": false,
    "website": "https://dansup.example"
  }'

const res = await fetch("https://pixelfed.social/api/v1/accounts/update_credentials", {
  method: "PATCH",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    display_name: "dansup",
    note: "Film and fog, mostly. Tallinn and the Baltic coast.",
    locked: false,
    website: "https://dansup.example",
  }),
});

const account = await res.json();

import requests

res = requests.patch(
    "https://pixelfed.social/api/v1/accounts/update_credentials",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "display_name": "dansup",
        "note": "Film and fog, mostly. Tallinn and the Baltic coast.",
        "locked": False,
        "website": "https://dansup.example",
    },
)

account = res.json()

use Illuminate\Support\Facades\Http;

$account = Http::acceptJson()
    ->withToken($token)
    ->patch('https://pixelfed.social/api/v1/accounts/update_credentials', [
        'display_name' => 'dansup',
        'note' => 'Film and fog, mostly. Tallinn and the Baltic coast.',
        'locked' => false,
        'website' => 'https://dansup.example',
    ])
    ->json();

Response

{
  "id": "2",
  "username": "dansup",
  "acct": "dansup",
  "display_name": "dansup",
  "discoverable": true,
  "locked": false,
  "followers_count": 1284,
  "following_count": 312,
  "statuses_count": 468,
  "note": "Film and fog, mostly. Tallinn and the Baltic coast.",
  "url": "https://pixelfed.social/dansup",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "avatar_static": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "header": "https://pixelfed.social/storage/headers/missing.png",
  "header_static": "https://pixelfed.social/storage/headers/missing.png",
  "bot": false,
  "emojis": [],
  "fields": [],
  "last_status_at": null,
  "created_at": "2019-03-02T18:21:07.000000Z",
  "bio": "Film and fog, mostly. Tallinn and the Baltic coast.",
  "advanced_atom": false,
  "disable_embeds": false,
  "mutual_mention_notifications": false,
  "hide_collections": false,
  "hide_like_counts": false,
  "hide_groups": false,
  "hide_stories": false,
  "disable_cw": false
}

{
  "message": "The display name field must not be greater than 30 characters.",
  "errors": {
    "display_name": ["The display name field must not be greater than 30 characters."]
  }
}

{
  "error": "You can only sync licenses twice per 24 hours"
}

GET/api/v1/accounts/{id}

Get an account

Mastodon compatible Supports _pe User token Scope read

Path parameters

idstringrequired

Query parameters

_peboolean

Returns

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

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

const account = await res.json();

import requests

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

account = res.json()

use Illuminate\Support\Facades\Http;

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

Response

{
  "id": "412760184563377",
  "username": "jonas",
  "acct": "jonas",
  "display_name": "Jonas Berg",
  "discoverable": true,
  "locked": true,
  "followers_count": 211,
  "following_count": 190,
  "statuses_count": 87,
  "note": "Long exposures and longer walks.",
  "url": "https://pixelfed.social/jonas",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/184/563/377/avatar.jpg",
  "avatar_static": "https://pixelfed.social/storage/avatars/412/760/184/563/377/avatar.jpg",
  "header": "https://pixelfed.social/storage/headers/missing.png",
  "header_static": "https://pixelfed.social/storage/headers/missing.png",
  "bot": false,
  "emojis": [],
  "fields": [],
  "last_status_at": null,
  "created_at": "2020-06-18T09:12:44.000000Z"
}

{
  "error": "Record not found"
}

GET/api/v1/accounts/lookup

Look up an account

Mastodon compatible Supports _pe No token

Query parameters

acctstringrequired

_peboolean

Returns

curl "https://pixelfed.social/api/v1/accounts/lookup?acct=dansup" \
  -H "Accept: application/json"

const res = await fetch("https://pixelfed.social/api/v1/accounts/lookup?acct=dansup", {
  headers: {
    Accept: "application/json",
  },
});

const account = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/accounts/lookup",
    headers={"Accept": "application/json"},
    params={
        "acct": "dansup",
    },
)

account = res.json()

use Illuminate\Support\Facades\Http;

$account = Http::acceptJson()->get('https://pixelfed.social/api/v1/accounts/lookup', [
    'acct' => 'dansup',
])->json();

Response

{
  "id": "2",
  "username": "dansup",
  "acct": "dansup",
  "display_name": "dansup",
  "locked": false,
  "followers_count": 1284,
  "following_count": 312,
  "statuses_count": 468,
  "url": "https://pixelfed.social/dansup",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "created_at": "2019-03-02T18:21:07.000000Z"
}

{
  "error": "Record not found"
}

{
  "message": "Too Many Attempts."
}

GET/api/v1/accounts/search

Search accounts

Mastodon compatible User token Scope read

Query parameters

qstringrequired

limitinteger

resolveboolean

Returns

curl "https://pixelfed.social/api/v1/accounts/search?q=mar&limit=5" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/accounts/search?q=mar&limit=5", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const accounts = await res.json();

import requests

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

accounts = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[{
  "id": "2",
  "username": "dansup",
  "acct": "dansup",
  "display_name": "dansup",
  "followers_count": 1284,
  "url": "https://pixelfed.social/dansup",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg"
}, {
  "id": "412760184563944",
  "username": "marek",
  "acct": "marek",
  "display_name": "Marek Tamm",
  "followers_count": 96,
  "url": "https://pixelfed.social/marek",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/184/563/944/avatar.jpg"
}]

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

GET/api/v1/accounts/{id}/statuses

List an account's posts

Mastodon compatible Supports _pe User token Scope read

Path parameters

idstringrequired

Query parameters

limitinteger

max_idstring

min_idstring

since_idstring

only_mediaboolean

media_typestring

exclude_repliesboolean

pinnedboolean

only_repostsboolean

_peboolean

Returns

curl "https://pixelfed.social/api/v1/accounts/2/statuses?limit=10&only_media=true" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/accounts/2/statuses?limit=10&only_media=true", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const posts = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/accounts/2/statuses",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    params={
        "limit": 10,
        "only_media": True,
    },
)

posts = res.json()

use Illuminate\Support\Facades\Http;

$posts = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1/accounts/2/statuses', [
        'limit' => 10,
        'only_media' => true,
    ])
    ->json();

Response

[{
  "id": "728341901556629504",
  "created_at": "2026-09-14T17:42:10.000Z",
  "url": "https://pixelfed.social/p/dansup/728341901556629504",
  "content": "Golden hour at the pier",
  "visibility": "public",
  "sensitive": false,
  "favourited": false,
  "reblogged": false,
  "bookmarked": false,
  "favourites_count": 42,
  "reblogs_count": 3,
  "replies_count": 5,
  "media_attachments": [{
    "id": "728341067224219648",
    "type": "image",
    "url": "https://pixelfed.social/storage/m/_v2/2/pier.jpg",
    "preview_url": "https://pixelfed.social/storage/m/_v2/2/pier_thumb.jpg",
    "description": "Wooden pier at sunset, two people fishing at the far end"
  }],
  "account": {
    "id": "2",
    "username": "dansup",
    "acct": "dansup",
    "display_name": "dansup"
  }
}]

{
  "error": "Account not found"
}

GET/api/v1/accounts/{id}/followers

List followers

Mastodon compatible Supports _pe User token Scope read

Path parameters

idstringrequired

Query parameters

limitinteger

max_idstring

min_idstring

pageinteger

_peboolean

Returns

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

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

const accounts = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/accounts/2/followers",
    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/accounts/2/followers', [
        'limit' => 40,
    ])
    ->json();

Response

[{
  "id": "412760184563377",
  "username": "jonas",
  "acct": "jonas",
  "display_name": "Jonas Berg",
  "locked": true,
  "url": "https://pixelfed.social/jonas",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/184/563/377/avatar.jpg"
}, {
  "id": "590118272640118784",
  "username": "liis",
  "acct": "liis@mastodon.social",
  "display_name": "Liis",
  "locked": false,
  "url": "https://mastodon.social/@liis",
  "avatar": "https://pixelfed.social/storage/cache/avatars/590/118/272/640/118/784/avatar.jpg"
}]

{
  "error": "Account moved"
}

GET/api/v1/accounts/{id}/following

List following

Mastodon compatible Supports _pe User token Scope read

Path parameters

idstringrequired

Query parameters

limitinteger

max_idstring

min_idstring

pageinteger

_peboolean

Returns

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

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

const accounts = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/accounts/412760184563377/following",
    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/accounts/412760184563377/following', [
        'limit' => 40,
    ])
    ->json();

Response

[{
  "id": "2",
  "username": "dansup",
  "acct": "dansup",
  "display_name": "dansup",
  "locked": false,
  "url": "https://pixelfed.social/dansup",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg"
}]

{
  "error": "Record not found"
}

GET/api/v1/accounts/relationships

Check relationships

Mastodon compatible Supports _pe User token

Query parameters

id[]array of stringsrequired

_peboolean

Returns

curl "https://pixelfed.social/api/v1/accounts/relationships?id[]=412760184563377" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://pixelfed.social/api/v1/accounts/relationships?id[]=412760184563377", {
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
  },
});

const relationships = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/accounts/relationships",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    params={
        "id[]": "412760184563377",
    },
)

relationships = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[{
  "id": "412760184563377",
  "following": true,
  "followed_by": true,
  "blocking": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}]

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

POST/api/v1/accounts/{id}/follow

Follow an account

Mastodon compatible User token Scope follow

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/follow" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/follow')
    ->json();

Response

{
  "id": "412760184563377",
  "following": false,
  "followed_by": false,
  "blocking": false,
  "muting": false,
  "muting_notifications": false,
  "requested": true,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "You cannot follow this user."
}

{
  "error": "Cannot follow an account that has moved!"
}

POST/api/v1/accounts/{id}/unfollow

Unfollow an account

Mastodon compatible User token Scope follow

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/unfollow" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/unfollow')
    ->json();

Response

{
  "id": "412760184563377",
  "following": false,
  "followed_by": true,
  "blocking": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "Invalid profile"
}

{
  "error": "Record not found"
}

POST/api/v1/accounts/{id}/remove_from_followers

Remove a follower

Mastodon compatible User token Scope follow

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/remove_from_followers" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/remove_from_followers')
    ->json();

Response

{
  "id": "2",
  "following": false,
  "followed_by": false,
  "blocking": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "Record not found"
}

GET/api/v1/follow_requests

List follow requests

Mastodon compatible User token Scope read

Query parameters

limitinteger

Returns

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

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

const accounts = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1/follow_requests",
    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/follow_requests', [
        'limit' => 40,
    ])
    ->json();

Response

[{
  "id": "412760184563377",
  "username": "jonas",
  "acct": "jonas",
  "display_name": "Jonas Berg",
  "locked": true,
  "url": "https://pixelfed.social/jonas",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/184/563/377/avatar.jpg"
}]

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

POST/api/v1/follow_requests/{id}/authorize

Accept a follow request

Mastodon compatible User token Scope follow

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/follow_requests/412760184563377/authorize" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/follow_requests/412760184563377/authorize')
    ->json();

Response

{
  "id": "412760184563377",
  "following": false,
  "followed_by": true,
  "blocking": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "Record not found"
}

{
  "error": "Cannot accept a request from an account that has migrated!"
}

POST/api/v1/follow_requests/{id}/reject

Reject a follow request

Mastodon compatible User token Scope follow

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/follow_requests/412760184563377/reject" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/follow_requests/412760184563377/reject')
    ->json();

Response

{
  "id": "412760184563377",
  "following": false,
  "followed_by": false,
  "blocking": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "Record not found"
}

POST/api/v1/accounts/{id}/block

Block an account

Mastodon compatible User token Scope write

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/block" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/block')
    ->json();

Response

{
  "id": "412760184563377",
  "following": false,
  "followed_by": false,
  "blocking": true,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "You cannot block an admin"
}

{
  "error": "You cannot block more than 200 accounts"
}

POST/api/v1/accounts/{id}/unblock

Unblock an account

Mastodon compatible User token Scope write

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/unblock" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/unblock')
    ->json();

Response

{
  "id": "412760184563377",
  "following": false,
  "followed_by": false,
  "blocking": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "Cannot unblock an account that has migrated!"
}

POST/api/v1/accounts/{id}/mute

Mute an account

Mastodon compatible User token Scope write

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/mute" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/mute')
    ->json();

Response

{
  "id": "412760184563377",
  "following": true,
  "followed_by": true,
  "blocking": false,
  "muting": true,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "You cannot mute more than 500 accounts"
}

POST/api/v1/accounts/{id}/unmute

Unmute an account

Mastodon compatible User token Scope write

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/unmute" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/unmute')
    ->json();

Response

{
  "id": "412760184563377",
  "following": true,
  "followed_by": true,
  "blocking": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "showing_reblogs": false,
  "endorsed": false
}

{
  "error": "Record not found"
}

GET/api/v1/preferences

Get preferences

Mastodon compatible User token Scope read

Returns

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

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

const preferences = await res.json();

import requests

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

preferences = res.json()

use Illuminate\Support\Facades\Http;

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

Response

{
  "posting:default:visibility": "public",
  "posting:default:sensitive": false,
  "posting:default:language": null,
  "reading:expand:media": "default",
  "reading:expand:spoilers": false
}

GET/api/v1/suggestions

List follow suggestions

Mastodon compatible User token Scope read

Returns

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

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

const suggestions = await res.json();

import requests

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

suggestions = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[]

GET/api/v1/endorsements

List featured accounts

Mastodon compatible User token Scope read

Returns

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

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

const accounts = await res.json();

import requests

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

accounts = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[]

POST/api/v1/accounts/{id}/pin

Feature an account

Mastodon compatible User token Scope read

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/pin" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/pin')
    ->json();

Response

[]

POST/api/v1/accounts/{id}/unpin

Unfeature an account

Mastodon compatible User token Scope read

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/accounts/412760184563377/unpin" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const relationship = await res.json();

import requests

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

relationship = res.json()

use Illuminate\Support\Facades\Http;

$relationship = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/accounts/412760184563377/unpin')
    ->json();

Response

[]

GET/api/v1/lists

List your lists

Mastodon compatible User token Scope read

Returns

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

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

const lists = await res.json();

import requests

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

lists = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[]

GET/api/v1/accounts/{id}/lists

List lists containing an account

Mastodon compatible User token Scope read

Path parameters

idstringrequired

Returns

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

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

const lists = await res.json();

import requests

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

lists = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[]

GET/api/v1/lists/{id}/accounts

List accounts in a list

Mastodon compatible User token Scope read

Path parameters

idstringrequired

Returns

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

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

const accounts = await res.json();

import requests

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

accounts = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[]

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