Pixelfed Statuses API

openapi: 3.1.0
info:
  title: Pixelfed REST Accounts Statuses 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: Statuses
  description: Creating, reading, and interacting with statuses (posts)
paths:
  /v1/statuses:
    post:
      operationId: createStatus
      summary: Post a new status
      description: 'Publish a new status. Media attachments, polls, content warnings, and visibility settings are all supported.

        '
      tags:
      - Statuses
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  description: The text content of the status
                media_ids:
                  type: array
                  items:
                    type: string
                  description: Array of media attachment IDs (max 4)
                in_reply_to_id:
                  type: string
                  description: ID of the status being replied to
                sensitive:
                  type: boolean
                  description: Mark media as sensitive
                spoiler_text:
                  type: string
                  description: Content warning text shown before post is expanded
                visibility:
                  type: string
                  enum:
                  - public
                  - unlisted
                  - private
                  - direct
                  description: Visibility of the status
                language:
                  type: string
                  description: ISO 639-1 language code for the status
                scheduled_at:
                  type: string
                  format: date-time
                  description: ISO 8601 datetime at which to schedule the status
          multipart/form-data:
            schema:
              type: object
              properties:
                status:
                  type: string
                media_ids[]:
                  type: array
                  items:
                    type: string
                visibility:
                  type: string
                  enum:
                  - public
                  - unlisted
                  - private
                  - direct
      responses:
        '200':
          description: Created status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /v1/statuses/{id}:
    get:
      operationId: getStatus
      summary: Get a single status
      description: Returns the status with the given ID.
      tags:
      - Statuses
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteStatus
      summary: Delete a status
      description: Deletes a status authored by the authenticated account.
      tags:
      - Statuses
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Status source object (for re-drafting)
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/statuses/{id}/context:
    get:
      operationId: getStatusContext
      summary: Get status context (thread)
      description: Returns ancestors and descendants of the status in the thread.
      tags:
      - Statuses
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Context object with ancestors and descendants
          content:
            application/json:
              schema:
                type: object
                properties:
                  ancestors:
                    type: array
                    items:
                      $ref: '#/components/schemas/Status'
                  descendants:
                    type: array
                    items:
                      $ref: '#/components/schemas/Status'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/statuses/{id}/favourited_by:
    get:
      operationId: getStatusFavouritedBy
      summary: Get accounts that favourited the status
      tags:
      - Statuses
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/limitParam'
      responses:
        '200':
          description: Array of accounts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Account'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/statuses/{id}/reblogged_by:
    get:
      operationId: getStatusRebloggedBy
      summary: Get accounts that reblogged the status
      tags:
      - Statuses
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/limitParam'
      responses:
        '200':
          description: Array of accounts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Account'
        '404':
          $ref: '#/components/responses/NotFound'
  /v1/statuses/{id}/favourite:
    post:
      operationId: favouriteStatus
      summary: Favourite a status
      tags:
      - Statuses
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/statuses/{id}/unfavourite:
    post:
      operationId: unfavouriteStatus
      summary: Undo favourite on a status
      tags:
      - Statuses
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/statuses/{id}/reblog:
    post:
      operationId: reblogStatus
      summary: Reblog a status
      tags:
      - Statuses
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                visibility:
                  type: string
                  enum:
                  - public
                  - unlisted
                  - private
      responses:
        '200':
          description: Updated status object (reblog wrapper)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/statuses/{id}/unreblog:
    post:
      operationId: unreblogStatus
      summary: Undo reblog of a status
      tags:
      - Statuses
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/statuses/{id}/bookmark:
    post:
      operationId: bookmarkStatus
      summary: Bookmark a status
      tags:
      - Statuses
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /v1/statuses/{id}/unbookmark:
    post:
      operationId: unbookmarkStatus
      summary: Remove bookmark from a status
      tags:
      - Statuses
      security:
      - OAuth2:
        - write
      - BearerAuth: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updated status object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '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
    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'
    UnprocessableEntity:
      description: Validation error
      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
  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/