Collections

GET/api/v1.1/collections/accounts/{id}

List an account's collections

Pixelfed only User token

Path parameters

idstringrequired

Query parameters

pageinteger

Returns

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

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

const collections = await res.json();

import requests

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

collections = res.json()

use Illuminate\Support\Facades\Http;

$collections = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1.1/collections/accounts/2', [
        'page' => 1,
    ])
    ->json();

Response

[{
  "id": "691204417380331520",
  "pid": "2",
  "visibility": "public",
  "title": "Harbour mornings",
  "description": "One winter of walks before work",
  "thumb": "https://pixelfed.social/storage/m/_v2/2/harbour_thumb.jpg",
  "url": "https://pixelfed.social/c/691204417380331520",
  "updated_at": "2026-03-30T06:48:12.000000Z",
  "published_at": "2026-02-11T07:05:41.000000Z",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "username": "dansup",
  "post_count": 14
}]

{
  "error": "Record not found"
}

GET/api/v1.1/collections/self

List your collections

Pixelfed only User token

Query parameters

pageinteger

Returns

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

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

const collections = await res.json();

import requests

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

collections = res.json()

use Illuminate\Support\Facades\Http;

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

Response

[{
  "id": "691204417380331520",
  "pid": "2",
  "visibility": "public",
  "title": "Harbour mornings",
  "description": "One winter of walks before work",
  "thumb": "https://pixelfed.social/storage/m/_v2/2/harbour_thumb.jpg",
  "url": "https://pixelfed.social/c/691204417380331520",
  "updated_at": "2026-03-30T06:48:12.000000Z",
  "published_at": "2026-02-11T07:05:41.000000Z",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "username": "dansup",
  "post_count": 14,
  "items": [{
    "id": "728341901556629504",
    "shortcode": "W4kQ2pLm",
    "url": "https://pixelfed.social/p/dansup/728341901556629504",
    "content_text": "Golden hour at the pier",
    "visibility": "public",
    "pf_type": "photo",
    "media_attachments": [{
      "id": "728341067224219648",
      "type": "image",
      "url": "https://pixelfed.social/storage/m/_v2/2/pier.jpg"
    }],
    "account": {
      "id": "2",
      "username": "dansup"
    }
  }]
}]

GET/api/v1.1/collections/view/{id}

Get a collection

Pixelfed only User token

Path parameters

idstringrequired

Returns

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

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

const collection = await res.json();

import requests

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

collection = res.json()

use Illuminate\Support\Facades\Http;

$collection = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1.1/collections/view/691204417380331520')
    ->json();

Response

{
  "id": "691204417380331520",
  "pid": "2",
  "visibility": "public",
  "title": "Harbour mornings",
  "description": "One winter of walks before work",
  "thumb": "https://pixelfed.social/storage/m/_v2/2/harbour_thumb.jpg",
  "url": "https://pixelfed.social/c/691204417380331520",
  "updated_at": "2026-03-30T06:48:12.000000Z",
  "published_at": "2026-02-11T07:05:41.000000Z",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "username": "dansup",
  "post_count": 14
}

{
  "error": "Record not found"
}

GET/api/v1.1/collections/items/{id}

List collection posts

Pixelfed only User token

Path parameters

idstringrequired

Query parameters

pageinteger

Returns

curl "https://pixelfed.social/api/v1.1/collections/items/691204417380331520?page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const posts = await res.json();

import requests

res = requests.get(
    "https://pixelfed.social/api/v1.1/collections/items/691204417380331520",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    params={
        "page": 1,
    },
)

posts = res.json()

use Illuminate\Support\Facades\Http;

$posts = Http::acceptJson()
    ->withToken($token)
    ->get('https://pixelfed.social/api/v1.1/collections/items/691204417380331520', [
        'page' => 1,
    ])
    ->json();

Response

[{
  "_v": 1,
  "id": "728341901556629504",
  "shortcode": "W4kQ2pLm",
  "uri": "https://pixelfed.social/p/dansup/728341901556629504",
  "url": "https://pixelfed.social/p/dansup/728341901556629504",
  "content": "Golden hour at the pier",
  "content_text": "Golden hour at the pier",
  "created_at": "2026-09-14T17:42:10.000Z",
  "favourites_count": 31,
  "reblogs_count": 2,
  "reply_count": 4,
  "sensitive": false,
  "visibility": "public",
  "pf_type": "photo",
  "local": true,
  "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",
    "mime": "image/jpeg",
    "blurhash": "UJF}Qo~W9aIV4.xuRjWB00WB-pof"
  }],
  "account": {
    "id": "2",
    "username": "dansup",
    "acct": "dansup",
    "display_name": "dansup",
    "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
    "local": true
  }
}]

{
  "error": "Record not found"
}

POST/api/v1.1/collections/update/{id}

Update a collection

Pixelfed only User token

Path parameters

idstringrequired

Body parameters

titlestring

descriptionstring

visibilitystringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1.1/collections/update/691204417380331520" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Harbour mornings",
    "description": "One winter of walks before work",
    "visibility": "public"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/collections/update/691204417380331520", {
  method: "POST",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    title: "Harbour mornings",
    description: "One winter of walks before work",
    visibility: "public",
  }),
});

const collection = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/collections/update/691204417380331520",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "title": "Harbour mornings",
        "description": "One winter of walks before work",
        "visibility": "public",
    },
)

collection = res.json()

use Illuminate\Support\Facades\Http;

$collection = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1.1/collections/update/691204417380331520', [
        'title' => 'Harbour mornings',
        'description' => 'One winter of walks before work',
        'visibility' => 'public',
    ])
    ->json();

Response

{
  "id": "691204417380331520",
  "pid": "2",
  "visibility": "public",
  "title": "Harbour mornings",
  "description": "One winter of walks before work",
  "thumb": "https://pixelfed.social/storage/m/_v2/2/harbour_thumb.jpg",
  "url": "https://pixelfed.social/c/691204417380331520",
  "updated_at": "2026-10-17T09:14:03.000000Z",
  "published_at": "2026-02-11T07:05:41.000000Z",
  "avatar": "https://pixelfed.social/storage/avatars/412/760/avatar.jpg",
  "username": "dansup",
  "post_count": 14
}

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

{
  "error": "Record not found"
}

POST/api/v1.1/collections/add

Add a post to a collection

Pixelfed only User token

Body parameters

collection_idstringrequired

post_idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1.1/collections/add" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "691204417380331520",
    "post_id": "728341901556629504"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/collections/add", {
  method: "POST",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    collection_id: "691204417380331520",
    post_id: "728341901556629504",
  }),
});

const post = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/collections/add",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "collection_id": "691204417380331520",
        "post_id": "728341901556629504",
    },
)

post = res.json()

use Illuminate\Support\Facades\Http;

$post = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1.1/collections/add', [
        'collection_id' => '691204417380331520',
        'post_id' => '728341901556629504',
    ])
    ->json();

Response

{
  "_v": 1,
  "id": "728341901556629504",
  "shortcode": "W4kQ2pLm",
  "url": "https://pixelfed.social/p/dansup/728341901556629504",
  "content_text": "Golden hour at the pier",
  "visibility": "public",
  "pf_type": "photo",
  "media_attachments": [{
    "id": "728341067224219648",
    "type": "image",
    "url": "https://pixelfed.social/storage/m/_v2/2/pier.jpg"
  }],
  "account": {
    "id": "2",
    "username": "dansup"
  }
}

{
  "error": "You can only add 100 posts per collection"
}

{
  "error": "Record not found"
}

POST/api/v1.1/collections/remove

Remove a post from a collection

Pixelfed only User token

Body parameters

collection_idstringrequired

post_idstringrequired

Returns

curl -X POST "https://pixelfed.social/api/v1.1/collections/remove" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "691204417380331520",
    "post_id": "728341901556629504"
  }'

const res = await fetch("https://pixelfed.social/api/v1.1/collections/remove", {
  method: "POST",
  headers: {
    Accept: "application/json",
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    collection_id: "691204417380331520",
    post_id: "728341901556629504",
  }),
});

const result = await res.json();

import requests

res = requests.post(
    "https://pixelfed.social/api/v1.1/collections/remove",
    headers={"Accept": "application/json", "Authorization": f"Bearer {token}"},
    json={
        "collection_id": "691204417380331520",
        "post_id": "728341901556629504",
    },
)

result = res.json()

use Illuminate\Support\Facades\Http;

$result = Http::acceptJson()
    ->withToken($token)
    ->post('https://pixelfed.social/api/v1.1/collections/remove', [
        'collection_id' => '691204417380331520',
        'post_id' => '728341901556629504',
    ])
    ->json();

Response

{
  "error": "You cannot delete the only post of a collection!"
}

{
  "error": "Record not found"
}

DELETE/api/v1.1/collections/delete/{id}

Delete a collection

Pixelfed only User token

Path parameters

idstringrequired

Returns

curl -X DELETE "https://pixelfed.social/api/v1.1/collections/delete/691204417380331520" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $TOKEN"

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

const result = await res.json();

import requests

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

result = res.json()

use Illuminate\Support\Facades\Http;

$result = Http::acceptJson()
    ->withToken($token)
    ->delete('https://pixelfed.social/api/v1.1/collections/delete/691204417380331520')
    ->json();

Response

{
  "error": "Record not found"
}

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