> ## Documentation Index
> Fetch the complete documentation index at: https://docs.autoposting.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List notifications (paginated)



## OpenAPI

````yaml /api-reference/openapi.json get /api/notifications
openapi: 3.1.0
info:
  title: Autoposting API
  description: >-
    Schedule, publish, and AI-enhance social content across X, LinkedIn,
    Instagram, Threads, and YouTube. All responses use the `{ "success":
    boolean, "data": ... }` envelope. Authenticate with an API key
    (`Authorization: Bearer sk-social-...` or `x-api-key: sk-social-...`).
  version: 1.0.0
servers:
  - url: https://app.autoposting.ai/api-proxy
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Agents
    description: >-
      Create and manage AI agents that autonomously generate and schedule
      content, trigger runs, inspect outputs, and track statistics.
  - name: API Keys
    description: >-
      Create, list, update, and revoke API keys for programmatic access to the
      Autoposting.ai API.
  - name: Auth
    description: >-
      Signup, login, logout, social login, profile management, email change, and
      session management.
  - name: Billing
    description: >-
      Manage subscriptions, credits, plan changes, billing history, and the
      customer portal.
  - name: Brands
    description: >-
      Create, list, update, delete, and reorder brands. Each brand maps to a set
      of social media accounts.
  - name: Carousels
    description: >-
      Create, manage, and AI-generate carousel posts for LinkedIn and other
      platforms.
  - name: Clips
    description: >-
      Upload, manage, render, and publish video clips, including multipart
      upload, AI candidate generation, and credit billing.
  - name: Knowledge Base
    description: >-
      Knowledge bases, document ingestion, semantic search, and AI content idea
      generation.
  - name: Notifications
    description: List, read, and manage in-app notifications and notification preferences.
  - name: Organizations
    description: >-
      Create, list, update, and delete organizations (workspaces), including a
      safeguarded deletion flow with a grace period.
  - name: Platform OAuth
    description: >-
      Connect social media accounts via OAuth and manage platform tokens for X,
      LinkedIn, Instagram, Threads, and YouTube.
  - name: Posts
    description: Create, manage, schedule, publish, and AI-enhance posts across platforms.
  - name: Teams
    description: >-
      Manage team members, invitations, invite links, permission groups,
      brand-level overrides, ownership transfers, and allowed email domains.
  - name: Usage
    description: >-
      Usage summaries, token breakdowns, feature access, onboarding progress,
      and account management endpoints.
  - name: Webhooks
    description: >-
      Configure outbound webhook endpoints to receive real-time event
      notifications from Autoposting.ai.
paths:
  /api/notifications:
    get:
      tags:
        - Notifications
      summary: List notifications (paginated)
      operationId: listNotifications
      parameters:
        - name: limit
          in: query
          required: false
          description: 'Items per page. Default: 50, max: 100.'
          schema:
            type: number
            default: 50
            maximum: 100
        - name: offset
          in: query
          required: false
          description: 'Items to skip. Default: 0.'
          schema:
            type: number
            default: 0
        - name: unreadOnly
          in: query
          required: false
          description: If true, returns only unread notifications.
          schema:
            type: boolean
      responses:
        '200':
          description: List of notifications
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      notifications:
                        type: array
                        items:
                          $ref: '#/components/schemas/NotificationItem'
                      total:
                        type: integer
                example:
                  success: true
                  data:
                    notifications:
                      - id: notif_01HXYZ
                        type: post.published
                        title: Post published successfully
                        body: Your post on LinkedIn has been published.
                        read: false
                        metadata:
                          postId: post_01HXYZ
                          brandSlug: acme-corp
                          platform: linkedin
                        createdAt: '2024-01-10T09:05:00Z'
                      - id: notif_02HXYZ
                        type: post.failed
                        title: Post failed
                        body: Your post on X failed to publish. Click to retry.
                        read: true
                        metadata:
                          postId: post_02HXYZ
                          platform: x
                        createdAt: '2024-01-09T14:00:00Z'
                    total: 2
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - error
                  - message
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  message:
                    type: string
                example:
                  success: false
                  error: unauthorized
                  message: Missing or invalid API key
components:
  schemas:
    NotificationItem:
      type: object
      required:
        - id
        - type
        - title
        - body
        - read
        - createdAt
      properties:
        id:
          type: string
          example: notif_01HXYZ
        type:
          $ref: '#/components/schemas/NotificationEventType'
        title:
          type: string
          example: Post published successfully
        body:
          type: string
          example: Your post on LinkedIn has been published.
        read:
          type: boolean
          example: false
        metadata:
          type: object
          additionalProperties: true
          description: Event-specific metadata (e.g. postId, brandSlug, platform).
          example:
            postId: post_01HXYZ
            brandSlug: acme-corp
            platform: linkedin
        createdAt:
          type: string
          format: date-time
          example: '2024-01-10T09:05:00Z'
    NotificationEventType:
      type: string
      description: Notification event type.
      enum:
        - post.published
        - post.failed
        - agent.run.completed
        - clip.render.completed
        - team.invitation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key as `Authorization: Bearer sk-social-...`'
    apiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API key as `x-api-key: sk-social-...`'

````