List Notifications

Get paginated notifications for your organization, sorted by most recent first. Returns 100 notifications per page.

OpenAPI

openapi: 3.1.0
info:
  title: Sipstory Public API
  description: >-
    API for managing social media posts, integrations, and media uploads in
    Sipstory.


    ## Authentication


    All endpoints require an API key passed in the `Authorization` header:


    ```

    Authorization: your-api-key

    ```


    Get your API key from Sipstory Settings.


    ## Rate Limits


    There is a limit of **30 requests per hour**.


    ## Terminology


    The UI uses `channel`, but the API uses `integration`. They refer to the
    same thing.


    ## Supported Platforms (27)


    **Social Platforms:** X (Twitter), LinkedIn, LinkedIn Page, Facebook,
    Instagram, Instagram Standalone, Threads, Bluesky, Mastodon, Warpcast
    (Farcaster), Nostr, VK


    **Video Platforms:** YouTube, TikTok


    **Community Platforms:** Reddit, Lemmy, Discord, Slack, Telegram


    **Design Platforms:** Pinterest, Dribbble


    **Blogging Platforms:** Medium, Dev.to, Hashnode, WordPress


    **Business:** Google My Business (GMB), Listmonk (newsletters)
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.sipstory.tech/public/v1
    description: Sipstory Cloud
  - url: https://{your-domain}/api/public/v1
    description: Self-hosted
    variables:
      your-domain:
        default: localhost:5000
        description: Your Sipstory instance domain
security:
  - ApiKeyAuth: []
tags:
  - name: Integrations
    description: Manage connected social media channels
  - name: Posts
    description: Create, list, and delete posts
  - name: Uploads
    description: Upload media files
  - name: Notifications
    description: View organization notifications
  - name: Analytics
    description: View analytics for integrations and posts
  - name: Video Generation
    description: Generate videos with AI
paths:
  /notifications:
    get:
      tags:
        - Notifications
      summary: List notifications
      description: >-
        Get paginated notifications for your organization, sorted by most recent
        first. Returns 100 notifications per page.
      operationId: listNotifications
      parameters:
        - name: page
          in: query
          required: false
          description: Page number (0-indexed). Defaults to 0.
          schema:
            type: integer
            minimum: 0
            default: 0
          example: 0
      responses:
        '200':
          description: Paginated list of notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationsResponse'
              example:
                notifications:
                  - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    content: Your post to X was published successfully
                    link: null
                    createdAt: '2025-01-15T10:30:00.000Z'
                  - id: b2c3d4e5-f6a7-8901-bcde-f12345678901
                    content: Failed to publish post to LinkedIn
                    link: null
                    createdAt: '2025-01-15T09:15:00.000Z'
                total: 250
                page: 0
                limit: 100
                hasMore: true
components:
  schemas:
    NotificationsResponse:
      type: object
      properties:
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
        total:
          type: integer
          description: Total number of notifications
        page:
          type: integer
          description: Current page number (0-indexed)
        limit:
          type: integer
          description: Number of notifications per page (always 100)
        hasMore:
          type: boolean
          description: Whether there are more pages available
    Notification:
      type: object
      properties:
        id:
          type: string
          description: Unique notification ID
        content:
          type: string
          description: Notification message
        link:
          type: string
          nullable: true
          description: Optional link associated with the notification
        createdAt:
          type: string
          format: date-time
          description: When the notification was created
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Your Sipstory API key