openapi: 3.1.0
info:
  title: Pixelfed REST Accounts Direct Messages 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: Direct Messages
  description: Pixelfed-specific direct messaging (v1.1)
paths:
  /v1.1/direct:
    get:
      operationId: getDirectMessages
      summary: Get direct messages
      description: Returns direct message conversations (Pixelfed-specific).
      tags:
      - Direct Messages
      security:
      - OAuth2:
        - read
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/maxIdParam'
      responses:
        '200':
          description: Array of direct message objects
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Missing or invalid OAuth token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        error_description:
          type: string
          description: Additional error details
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of results to return (default 20, max 80)
      schema:
        type: integer
        default: 20
        maximum: 80
    maxIdParam:
      name: max_id
      in: query
      description: Return results older 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/