OpenPost Notifications API

The Notifications API from OpenPost — 7 operation(s) for notifications.

GitHub OpenAPI

Operations 9

GET /notifications List the current user's stored notifications #
POST /notifications/delete Delete notifications from a workspace inbox #
POST /notifications/mutes Pause optional notification email temporarily #
DELETE /notifications/mutes/{id} End a notification Mute now #
GET /notifications/preferences Get notification delivery preferences #
PUT /notifications/preferences Update notification delivery preferences #
GET /notifications/queue-reminders/{workspace_id} Get personal email reminders for a Workspace queue #
PUT /notifications/queue-reminders/{workspace_id} Update personal email reminders for a Workspace queue #
POST /notifications/read Mark notifications in a workspace inbox read #

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/openpo-st:openpo-st-notifications-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

openpo-st-notifications-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact:
    email: hello@openpo.st
    name: OpenPost support
    url: https://openpo.st/contact
  description: OpenPost HTTP API for workspace-scoped social publishing. Use it to inspect accounts and provider readiness, manage media and publications, schedule work, and read publishing results. Every operation still follows token scopes, workspace roles, plan limits, provider capabilities, and destination validation.
  license:
    identifier: AGPL-3.0-only
    name: AGPL-3.0-only
  termsOfService: https://openpo.st/terms
  title: OpenPost Notifications API
  version: 1.0.0
servers:
- description: OpenPost Hosted service
  url: https://app.openpo.st/api/v1
- description: The OpenPost instance serving this contract
  url: /api/v1
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Notifications
paths:
  /notifications:
    get:
      operationId: list-notifications
      parameters:
      - description: Workspace whose inbox should be listed
        explode: false
        in: query
        name: workspace_id
        required: true
        schema:
          description: Workspace whose inbox should be listed
          type: string
      - description: Opaque pagination cursor
        explode: false
        in: query
        name: cursor
        schema:
          description: Opaque pagination cursor
          type: string
      - explode: false
        in: query
        name: limit
        schema:
          default: 30
          format: int64
          maximum: 100
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPage'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: List the current user's stored notifications
      tags:
      - Notifications
      x-openpost-automation:
        access: read
        effect: query
        exposure: alpha
        idempotency: none
        retry: transient
        selectors:
        - label_path: name
          operation_id: list-workspaces
          parameter: workspace_id
          value_path: id
  /notifications/delete:
    post:
      operationId: delete-notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeNotificationsInputBody'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: Delete notifications from a workspace inbox
      tags:
      - Notifications
  /notifications/mutes:
    post:
      description: Creates or replaces the current account-wide or Workspace-specific Mute. In-app notifications remain immediate and Transactional email always bypasses Mutes.
      operationId: create-notification-mute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MuteCreate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferenceSettings'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: Pause optional notification email temporarily
      tags:
      - Notifications
      x-openpost-automation:
        access: write
        effect: local-mutation
        exposure: disabled
        idempotency: none
        retry: never
  /notifications/mutes/{id}:
    delete:
      description: Ends an existing Mute. Repeating the request for that Mute is safe and returns the current authoritative preferences.
      operationId: end-notification-mute
      parameters:
      - description: Mute ID
        in: path
        name: id
        required: true
        schema:
          description: Mute ID
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferenceSettings'
          description: OK
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Found
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: End a notification Mute now
      tags:
      - Notifications
      x-openpost-automation:
        access: write
        effect: local-mutation
        exposure: disabled
        idempotency: none
        retry: never
  /notifications/preferences:
    get:
      operationId: get-notification-preferences
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferenceSettings'
          description: OK
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: Get notification delivery preferences
      tags:
      - Notifications
      x-openpost-automation:
        access: read
        effect: query
        exposure: disabled
        idempotency: none
        retry: transient
    put:
      operationId: update-notification-preferences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreferenceUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferenceSettings'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: Update notification delivery preferences
      tags:
      - Notifications
  /notifications/queue-reminders/{workspace_id}:
    get:
      operationId: get-workspace-queue-reminders
      parameters:
      - description: Workspace whose queue should be monitored
        in: path
        name: workspace_id
        required: true
        schema:
          description: Workspace whose queue should be monitored
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueReminderSettings'
          description: OK
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: Get personal email reminders for a Workspace queue
      tags:
      - Notifications
    put:
      operationId: update-workspace-queue-reminders
      parameters:
      - description: Workspace whose queue should be monitored
        in: path
        name: workspace_id
        required: true
        schema:
          description: Workspace whose queue should be monitored
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueueReminderUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueReminderSettings'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: Update personal email reminders for a Workspace queue
      tags:
      - Notifications
  /notifications/read:
    post:
      operationId: mark-notifications-read
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeNotificationsInputBody'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      summary: Mark notifications in a workspace inbox read
      tags:
      - Notifications
components:
  schemas:
    QueueReminderUpdate:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/QueueReminderUpdate.json
          format: uri
          readOnly: true
          type: string
        low_runway_enabled:
          type: boolean
        queue_emptied_enabled:
          type: boolean
        runway_days:
          format: int64
          maximum: 30
          minimum: 1
          type: integer
      required:
      - low_runway_enabled
      - queue_emptied_enabled
      - runway_days
      type: object
    PreferenceSettings:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/PreferenceSettings.json
          format: uri
          readOnly: true
          type: string
        digest_configured:
          type: boolean
        digest_time:
          examples:
          - 09:00
          type: string
        digest_timezone:
          examples:
          - Europe/Lisbon
          type: string
        email_address:
          type: string
        email_available:
          type: boolean
        mutes:
          items:
            $ref: '#/components/schemas/Mute'
          type:
          - array
          - 'null'
        preferences:
          additionalProperties:
            $ref: '#/components/schemas/ChannelPreference'
          type: object
        topic_definitions:
          items:
            $ref: '#/components/schemas/TopicDefinition'
          type:
          - array
          - 'null'
      required:
      - preferences
      - topic_definitions
      - email_available
      - email_address
      - digest_time
      - digest_timezone
      - digest_configured
      - mutes
      type: object
    MuteCreate:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/MuteCreate.json
          format: uri
          readOnly: true
          type: string
        ends_at:
          format: date-time
          type: string
        scope:
          enum:
          - account
          - workspace
          type: string
        workspace_id:
          type: string
      required:
      - scope
      - ends_at
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
          - array
          - 'null'
        instance:
          description: A URI reference that identifies the specific occurrence of the problem.
          examples:
          - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
          - 400
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
          examples:
          - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
          - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ChangeNotificationsInputBody:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/ChangeNotificationsInputBody.json
          format: uri
          readOnly: true
          type: string
        all:
          description: Apply to every workspace and account-wide notification visible in this inbox
          type: boolean
        ids:
          description: Notification IDs within the workspace inbox
          items:
            type: string
          type:
          - array
          - 'null'
        workspace_id:
          description: Workspace whose inbox should be changed
          type: string
      required:
      - workspace_id
      type: object
    NotificationPage:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/NotificationPage.json
          format: uri
          readOnly: true
          type: string
        items:
          items:
            $ref: '#/components/schemas/UserNotification'
          type:
          - array
          - 'null'
        next_cursor:
          type: string
        unread_count:
          format: int64
          type: integer
      required:
      - items
      - unread_count
      type: object
    PreferenceUpdate:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/PreferenceUpdate.json
          format: uri
          readOnly: true
          type: string
        digest_time:
          pattern: ^[0-2][0-9]:[0-5][0-9]$
          type: string
        digest_timezone:
          type: string
        preferences:
          additionalProperties:
            $ref: '#/components/schemas/ChannelPreference'
          type: object
      required:
      - preferences
      - digest_time
      - digest_timezone
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Mute:
      additionalProperties: false
      properties:
        ends_at:
          format: date-time
          type: string
        id:
          type: string
        scope:
          enum:
          - account
          - workspace
          type: string
        starts_at:
          format: date-time
          type: string
        workspace_id:
          type: string
        workspace_name:
          type: string
      required:
      - id
      - scope
      - starts_at
      - ends_at
      type: object
    TopicDefinition:
      additionalProperties: false
      properties:
        critical_in_app:
          type: boolean
        default_preference:
          $ref: '#/components/schemas/ChannelPreference'
        email_frequencies:
          items:
            type: string
          type:
          - array
          - 'null'
        email_mutable:
          type: boolean
        group:
          type: string
        id:
          type: string
        in_app_mutable:
          type: boolean
        mute_applies:
          type: boolean
        presentation_key:
          type: string
        transactional:
          type: boolean
      required:
      - id
      - group
      - presentation_key
      - critical_in_app
      - transactional
      - in_app_mutable
      - email_mutable
      - mute_applies
      - email_frequencies
      - default_preference
      type: object
    UserNotification:
      additionalProperties: false
      properties:
        actions:
          items:
            $ref: '#/components/schemas/NotificationAction'
          type:
          - array
          - 'null'
        body:
          type: string
        created_at:
          format: date-time
          type: string
        href:
          type: string
        id:
          type: string
        payload_json:
          type: string
        read_at:
          format: date-time
          type: string
        title:
          type: string
        type:
          type: string
        user_id:
          type: string
        workspace_id:
          type: string
      required:
      - id
      - user_id
      - workspace_id
      - type
      - title
      - body
      - href
      - payload_json
      - created_at
      type: object
    ChannelPreference:
      additionalProperties: false
      properties:
        email_frequency:
          enum:
          - 'off'
          - immediate
          - daily
          type: string
        in_app:
          type: boolean
      required:
      - in_app
      - email_frequency
      type: object
    NotificationAction:
      additionalProperties: false
      properties:
        href:
          type: string
        kind:
          type: string
        label:
          type: string
        operation:
          type: string
        target_id:
          type: string
      required:
      - label
      type: object
    QueueReminderSettings:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
          - https://example.com/api/v1/schemas/QueueReminderSettings.json
          format: uri
          readOnly: true
          type: string
        activated:
          type: boolean
        email_available:
          type: boolean
        low_runway_enabled:
          type: boolean
        queue_emptied_enabled:
          type: boolean
        runway_days:
          format: int64
          maximum: 30
          minimum: 1
          type: integer
        workspace_id:
          type: string
        workspace_name:
          type: string
        workspace_timezone:
          type: string
      required:
      - workspace_id
      - workspace_name
      - workspace_timezone
      - low_runway_enabled
      - queue_emptied_enabled
      - runway_days
      - email_available
      - activated
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: OpenPost API token or session JWT
      scheme: bearer
      type: http
    sessionCookie:
      in: cookie
      name: openpost_session
      type: apiKey