Pixelfed

Pixelfed Notifications API

Notification retrieval and management

Documentation GitHub OpenAPI

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/pixelfed-notifications-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: Pixelfed REST Accounts Notifications API
  description: 'Mastodon-compatible REST API for the Pixelfed federated photo-sharing platform. Provides endpoints for accounts, statuses, timelines, media, notifications, search, collections, stories, direct messages, and instance/federation metadata. All authenticated calls use OAuth2 Bearer tokens. Every Pixelfed instance exposes this API independently at its own domain; there is no single central API host.

    '
  version: '1.1'
  contact:
    name: Pixelfed
    email: hello@pixelfed.org
    url: https://pixelfed.org
  license:
    name: AGPL-3.0
    url: https://github.com/pixelfed/pixelfed/blob/dev/LICENSE
  x-logo:
    url: https://pixelfed.org/img/logo.svg
servers:
- url: https://{instance}/api
  description: A Pixelfed instance
  variables:
    instance:
      default: pixelfed.social
      description: Hostname of the Pixelfed instance
security:
- OAuth2:
  - read
  - write
  - follow
  - push
- BearerAuth: []
tags:
- name: Notifications
  description: Notification retrieval and management
paths:
  /v1/notifications:
    get:
      operationId: listNotifications
      summary: List notifications
      description: Returns notifications for the authenticated account.
      tags:
      - Notifications
      security:
      - OAuth2:
        - read
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/maxIdParam'
      - $ref: '#/components/parameters/sinceIdParam'
      - $ref: '#/components/parameters/minIdParam'
      - name: types[]
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - mention
            - status
            - reblog
            - follow
            - follow_request
            - favourite
            - poll
            - update
      - name: exclude_types[]
        in: query
        schema:
          type: array
          items:
            type: string
      - name: account_id
        in: query
        schema:
          type: string
        description: Filter by account
      responses:
        '200':
          description: Array of notifications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Notification'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/notifications/{id}:
    get:
      operationId: getNotification
      summary: Get a single notification
      tags:
      - Notifications
      security:
      - OAuth2:
        - read
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Notification object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/notifications/clear:
    post:
      operationId: clearNotifications
      summary: Clear all notifications
      description: Clears all notifications for the authenticated account.
      tags:
      - Notifications
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      responses:
        '200':
          description: Empty object on success
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/notifications/{id}/dismiss:
    post:
      operationId: dismissNotification
      summary: Dismiss a single notification
      tags:
      - Notifications
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Empty object on success
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Mention:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        acct:
          type: string
        url:
          type: string
          format: uri
    MediaAttachment:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - unknown
          - image
          - gifv
          - video
          - audio
        url:
          type: string
          format: uri
          nullable: true
        preview_url:
          type: string
          format: uri
          nullable: true
        remote_url:
          type: string
          format: uri
          nullable: true
        meta:
          type: object
        description:
          type: string
          nullable: true
        blurhash:
          type: string
          nullable: true
    Emoji:
      type: object
      properties:
        shortcode:
          type: string
        url:
          type: string
          format: uri
        static_url:
          type: string
          format: uri
        visible_in_picker:
          type: boolean
    PreviewCard:
      type: object
      properties:
        url:
          type: string
          format: uri
        title:
          type: string
        description:
          type: string
        type:
          type: string
          enum:
          - link
          - photo
          - video
          - rich
        image:
          type: string
          format: uri
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        error_description:
          type: string
          description: Additional error details
    Status:
      type: object
      description: Represents a status (post) in the Pixelfed / Mastodon API
      properties:
        id:
          type: string
          example: '987654321'
        created_at:
          type: string
          format: date-time
        in_reply_to_id:
          type: string
          nullable: true
        in_reply_to_account_id:
          type: string
          nullable: true
        sensitive:
          type: boolean
        spoiler_text:
          type: string
        visibility:
          type: string
          enum:
          - public
          - unlisted
          - private
          - direct
        language:
          type: string
          nullable: true
        uri:
          type: string
          format: uri
        url:
          type: string
          format: uri
          nullable: true
        replies_count:
          type: integer
        reblogs_count:
          type: integer
        favourites_count:
          type: integer
        content:
          type: string
          description: HTML-encoded content of the status
        reblog:
          nullable: true
          allOf:
          - $ref: '#/components/schemas/Status'
        application:
          type: object
          nullable: true
          properties:
            name:
              type: string
            website:
              type: string
              format: uri
              nullable: true
        account:
          $ref: '#/components/schemas/Account'
        media_attachments:
          type: array
          items:
            $ref: '#/components/schemas/MediaAttachment'
        mentions:
          type: array
          items:
            $ref: '#/components/schemas/Mention'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        emojis:
          type: array
          items:
            $ref: '#/components/schemas/Emoji'
        card:
          nullable: true
          $ref: '#/components/schemas/PreviewCard'
        poll:
          nullable: true
          $ref: '#/components/schemas/Poll'
        favourited:
          type: boolean
        reblogged:
          type: boolean
        muted:
          type: boolean
        bookmarked:
          type: boolean
        pinned:
          type: boolean
    Field:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
        verified_at:
          type: string
          format: date-time
          nullable: true
    Poll:
      type: object
      properties:
        id:
          type: string
        expires_at:
          type: string
          format: date-time
          nullable: true
        expired:
          type: boolean
        multiple:
          type: boolean
        votes_count:
          type: integer
        options:
          type: array
          items:
            type: object
            properties:
              title:
                type: string
              votes_count:
                type: integer
                nullable: true
        voted:
          type: boolean
    Notification:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - mention
          - status
          - reblog
          - follow
          - follow_request
          - favourite
          - poll
          - update
          - admin.sign_up
        created_at:
          type: string
          format: date-time
        account:
          $ref: '#/components/schemas/Account'
        status:
          nullable: true
          $ref: '#/components/schemas/Status'
    Account:
      type: object
      description: Represents a Pixelfed / Mastodon-compatible account
      properties:
        id:
          type: string
          description: Unique identifier of the account
          example: '123456789'
        username:
          type: string
          description: The account's username (local part)
          example: alice
        acct:
          type: string
          description: 'Webfinger account URI. Equal to username for local accounts, or username@domain for remote accounts.

            '
          example: alice@pixelfed.social
        display_name:
          type: string
          description: Display name of the account
          example: Alice
        locked:
          type: boolean
          description: Whether the account requires manual follow approval
        created_at:
          type: string
          format: date-time
        note:
          type: string
          description: Biography / profile note (HTML)
        url:
          type: string
          format: uri
          description: Profile URL
        avatar:
          type: string
          format: uri
          description: URL to the account's avatar image
        avatar_static:
          type: string
          format: uri
          description: URL to a static version of the avatar
        header:
          type: string
          format: uri
          description: URL to the account's header image
        header_static:
          type: string
          format: uri
        followers_count:
          type: integer
        following_count:
          type: integer
        statuses_count:
          type: integer
        emojis:
          type: array
          items:
            $ref: '#/components/schemas/Emoji'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
    Tag:
      type: object
      properties:
        name:
          type: string
        url:
          type: string
          format: uri
        history:
          type: array
          items:
            type: object
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid OAuth token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of results to return (default 20, max 80)
      schema:
        type: integer
        default: 20
        maximum: 80
    minIdParam:
      name: min_id
      in: query
      description: Return results immediately newer than this ID
      schema:
        type: string
    maxIdParam:
      name: max_id
      in: query
      description: Return results older than this ID
      schema:
        type: string
    sinceIdParam:
      name: since_id
      in: query
      description: Return results newer than this ID
      schema:
        type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{instance}/oauth/authorize
          tokenUrl: https://{instance}/oauth/token
          scopes:
            read: Read-only access to account data and timelines
            write: Write access to post statuses and manage account
            follow: Manage follows, blocks, and mutes
            push: Manage Web Push subscriptions
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
externalDocs:
  description: Pixelfed Documentation
  url: https://docs.pixelfed.org/

Pixelfed Notifications API

Documentation

Specifications

SDKs

Other Resources