Piknik.Spot

Piknik.Spot Notifications API

The Notifications API from Piknik.Spot — 8 operation(s) for notifications.

GitHub OpenAPI

Operations 12

GET /notifications/announcement-count GET /notifications/announcement-count #
GET /notifications/debug GET /notifications/debug #
GET /notifications/preferences GET /notifications/preferences #
PUT /notifications/preferences PUT /notifications/preferences #
GET /notifications GET /notifications #
PUT /notifications PUT /notifications #
POST /notifications/subscribe POST /notifications/subscribe #
DELETE /notifications/subscribe DELETE /notifications/subscribe #
POST /notifications/test POST /notifications/test #
GET /notifications/vapid-key GET /notifications/vapid-key #
GET /v2/notifications/announcements GET /v2/notifications/announcements #
PUT /v2/notifications/announcements PUT /v2/notifications/announcements #

Documentation

📖
Documentation
https://piknik.spot/api/docs
📖
APIReference
https://piknik.spot/api/docs
📖
GettingStarted
https://piknik.spot/skills/piknik-rest-api/SKILL.md
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/authentication/piknik-spot-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/rate-limits/piknik-spot-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/openapi/piknik-spot-notifications-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/scopes/piknik-spot-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/conventions/piknik-spot-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/conventions/piknik-spot-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/errors/piknik-spot-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/data-model/piknik-spot-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/piknik-spot/refs/heads/main/asyncapi/piknik-spot-webhooks.yml

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

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

piknik-spot-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Piknik.Spot Notifications API
  description: Piknik.Spot API with OAuth2 authentication, Model Context Protocol (MCP) support, and Agent-to-Agent (A2A) capabilities for AI-powered local food system interactions.
  version: 1.0.0
  contact:
    name: Piknik.Spot API Support
    url: https://piknik.spot
    email: info@piknik.spot
  license:
    name: Proprietary
    url: https://piknik.spot/terms
servers:
- url: https://piknik.spot/api
  description: Production Server
- url: http://localhost:3000/api
  description: Development Server
tags:
- name: Notifications
paths:
  /notifications/announcement-count:
    get:
      summary: GET /notifications/announcement-count
      description: Endpoint for /notifications/announcement-count
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      operationId: getNotificationsAnnouncementCount
      x-operation-id-source: derived
  /notifications/debug:
    get:
      summary: GET /notifications/debug
      description: Endpoint for /notifications/debug
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      operationId: getNotificationsDebug
      x-operation-id-source: derived
  /notifications/preferences:
    get:
      summary: GET /notifications/preferences
      description: Endpoint for /notifications/preferences
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      operationId: getNotificationsPreferences
      x-operation-id-source: derived
    put:
      summary: PUT /notifications/preferences
      description: Endpoint for /notifications/preferences
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      operationId: putNotificationsPreferences
      x-operation-id-source: derived
  /notifications:
    get:
      summary: GET /notifications
      description: Endpoint for /notifications
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
        description: Maximum number of results
      - name: offset
        in: query
        schema:
          type: integer
        description: Pagination offset
      operationId: getNotifications
      x-operation-id-source: derived
    put:
      summary: PUT /notifications
      description: Endpoint for /notifications
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
        description: Maximum number of results
      - name: offset
        in: query
        schema:
          type: integer
        description: Pagination offset
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      operationId: putNotifications
      x-operation-id-source: derived
  /notifications/subscribe:
    post:
      summary: POST /notifications/subscribe
      description: Endpoint for /notifications/subscribe
      tags:
      - Notifications
      responses:
        '201':
          description: Created successfully
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      operationId: postNotificationsSubscribe
      x-operation-id-source: derived
    delete:
      summary: DELETE /notifications/subscribe
      description: Endpoint for /notifications/subscribe
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      operationId: deleteNotificationsSubscribe
      x-operation-id-source: derived
  /notifications/test:
    post:
      summary: POST /notifications/test
      description: Endpoint for /notifications/test
      tags:
      - Notifications
      responses:
        '201':
          description: Created successfully
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      operationId: postNotificationsTest
      x-operation-id-source: derived
  /notifications/vapid-key:
    get:
      summary: GET /notifications/vapid-key
      description: Endpoint for /notifications/vapid-key
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
      operationId: getNotificationsVapidKey
      x-operation-id-source: derived
  /v2/notifications/announcements:
    get:
      summary: GET /v2/notifications/announcements
      description: Endpoint for /v2/notifications/announcements
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      parameters:
      - name: page
        in: query
        schema:
          type: string
        description: page parameter
      - name: limit
        in: query
        schema:
          type: integer
        description: Maximum number of results
      operationId: getV2NotificationsAnnouncements
      x-operation-id-source: derived
    put:
      summary: PUT /v2/notifications/announcements
      description: Endpoint for /v2/notifications/announcements
      tags:
      - Notifications
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth: []
      - cookieAuth: []
      parameters:
      - name: page
        in: query
        schema:
          type: string
        description: page parameter
      - name: limit
        in: query
        schema:
          type: integer
        description: Maximum number of results
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      operationId: putV2NotificationsAnnouncements
      x-operation-id-source: derived
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        error_description:
          type: string
          description: Detailed error description
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: next-auth.session-token
      description: Session-based authentication for web browsers
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for external applications and AI agents
      flows:
        authorizationCode:
          authorizationUrl: https://piknik.spot/api/oauth/authorize
          tokenUrl: https://piknik.spot/api/oauth/token
          refreshUrl: https://piknik.spot/api/oauth/token
          scopes:
            marketplace:write: Create and manage marketplace listings
            events:write: Create and manage community events
            read:profile: Read user profile information
            write:profile: Update user profile information
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'OAuth2 access token (JWT). Include in Authorization header as: Bearer {token}'