Conversations

GET/api/v1/conversations

List conversations

Mastodon compatible User token Scope read

Query parameters

limitinteger

max_idstring

min_idstring

since_idstring

scopestring

include_groupsboolean

Returns

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

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

const conversations = await res.json();

import requests

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

conversations = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[{
  "id": "5821",
  "unread": true,
  "accounts": [{
    "id": "412760184563377",
    "username": "jonas",
    "acct": "jonas",
    "display_name": "Jonas",
    "url": "https://pixelfed.social/jonas",
    "avatar": "https://pixelfed.social/storage/avatars/412/760/377/avatar.jpg"
  }],
  "last_status": {
    "id": "728371554032959488",
    "uri": "https://pixelfed.social/i/dm/messages/728371554032959488",
    "url": "https://pixelfed.social/i/dm/messages/728371554032959488",
    "in_reply_to_id": null,
    "in_reply_to_account_id": null,
    "reblog": null,
    "content": "Are you going to the harbour walk on Saturday?",
    "content_text": "Are you going to the harbour walk on Saturday?",
    "created_at": "2026-09-14T19:40:18.000Z",
    "edited_at": null,
    "visibility": "direct",
    "sensitive": false,
    "spoiler_text": "",
    "replies_count": 0,
    "reblogs_count": 0,
    "favourites_count": 0,
    "mentions": [{
      "id": "2",
      "username": "dansup",
      "acct": "dansup",
      "url": "https://pixelfed.social/dansup"
    }],
    "tags": [],
    "emojis": [],
    "media_attachments": [],
    "pf_type": "text",
    "account": {
      "id": "412760184563377",
      "username": "jonas",
      "acct": "jonas"
    }
  }
}]

{
  "message": "The selected scope is invalid.",
  "errors": {
    "scope": ["The selected scope is invalid."]
  }
}

POST/api/v1/conversations/{id}/read

Mark a conversation as read

Mastodon compatible User token Scope write

Path parameters

idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1/conversations/5821/read" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const conversation = await res.json();

import requests

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

conversation = res.json()

use Illuminate\Support\Facades\Http;

$conversation = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1/conversations/5821/read')
    ->json();

Response

{
  "id": "5821",
  "unread": false,
  "accounts": [{
    "id": "412760184563377",
    "username": "jonas",
    "acct": "jonas"
  }],
  "last_status": {
    "id": "728371554032959488",
    "content": "Are you going to the harbour walk on Saturday?",
    "visibility": "direct",
    "account": {
      "id": "412760184563377",
      "username": "jonas",
      "acct": "jonas"
    }
  }
}

{
  "error": "Record not found"
}

DELETE/api/v1/conversations/{id}

Remove a conversation

Mastodon compatible User token Scope write

Path parameters

idstringrequired

Returns

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

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

const res = await res.json();

import requests

res = requests.delete(
    "https://pixelfed.social/api/v1/conversations/5821",
    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/v1/conversations/5821')
    ->json();

Response

[]

{
  "error": "Record not found"
}

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