ClusterHack Notifications API

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

GitHub OpenAPI

Operations 7

GET /api/v1/notifications/ Notifications list #
POST /api/v1/notifications/read-all/ Notifications read all create #
POST /api/v1/notifications/unread-all/ Notifications unread all create #
GET /api/v1/notifications/{id}/ Notifications retrieve #
POST /api/v1/notifications/{id}/dismiss/ Notifications dismiss create #
POST /api/v1/notifications/{id}/read/ Notifications read create #
POST /api/v1/notifications/{id}/unread/ Notifications unread create #

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/clusterhack-dev:clusterhack-dev-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. See our Privacy Policy and Terms.

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

OpenAPI Specification

clusterhack-dev-notifications-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Clusterhack Dev Notifications API
  version: 1.3.0
  description: 'Operations tagged notifications across 2 of this provider''s published API definitions: clusterhack-dev-openapi-original.json, clusterhack-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://clusterhack.dev
  description: Production. Not stated in the provider spec (no servers[]); the spec is served from https://clusterhack.dev/api/schema/ and its paths are rooted at /api/v1 and /geo-api.
tags:
- name: Notifications
paths:
  /api/v1/notifications/:
    get:
      operationId: notifications_list
      parameters:
      - in: query
        name: event
        schema:
          type: string
        description: Event slug
      - in: query
        name: include_dismissed
        schema:
          type: string
        description: Set to 1 to include dismissed notifications
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: state
        schema:
          type: string
          enum:
          - all
          - read
          - unread
        description: 'Read state


          * `all` - all

          * `read` - read

          * `unread` - unread'
      - in: query
        name: type
        schema:
          type: string
        description: Notification type
      tags:
      - Notifications
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationList'
          description: ''
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Notifications list
      x-summary-source: derived
  /api/v1/notifications/read-all/:
    post:
      operationId: notifications_read_all_create
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
          description: ''
        '400':
          description: The request body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Notifications read all create
      x-summary-source: derived
  /api/v1/notifications/unread-all/:
    post:
      operationId: notifications_unread_all_create
      description: 'The twin of ``read-all``. The HTML workspace has had the "mark all

        unread" button since apps/event/views.py; the API only had one half.'
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
          description: ''
        '400':
          description: The request body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Notifications unread all create
      x-summary-source: derived
  /api/v1/notifications/{id}/:
    get:
      operationId: notifications_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this send email to user.
        required: true
      tags:
      - Notifications
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
          description: ''
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '404':
          description: No such object, or it is not visible to you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Notifications retrieve
      x-summary-source: derived
  /api/v1/notifications/{id}/dismiss/:
    post:
      operationId: notifications_dismiss_create
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this send email to user.
        required: true
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
          description: ''
        '400':
          description: The request body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '404':
          description: No such object, or it is not visible to you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Notifications dismiss create
      x-summary-source: derived
  /api/v1/notifications/{id}/read/:
    post:
      operationId: notifications_read_create
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this send email to user.
        required: true
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
          description: ''
        '400':
          description: The request body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '404':
          description: No such object, or it is not visible to you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Notifications read create
      x-summary-source: derived
  /api/v1/notifications/{id}/unread/:
    post:
      operationId: notifications_unread_create
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this send email to user.
        required: true
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NotificationRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notification'
          description: ''
        '400':
          description: The request body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '404':
          description: No such object, or it is not visible to you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Notifications unread create
      x-summary-source: derived
components:
  schemas:
    ErrorDetail:
      type: object
      description: The body DRF returns for a handled error.
      properties:
        detail:
          type: string
          description: Human-readable explanation of the failure.
      required:
      - detail
    PaginatedNotificationList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
    ValidationError:
      type: object
      description: Field-keyed validation errors. Errors that belong to no single field appear under `non_field_errors`.
      additionalProperties:
        type: array
        items:
          type: string
    NotificationRequest:
      type: object
      properties:
        type:
          type: string
          minLength: 1
          title: Message type
          maxLength: 100
        message:
          type: string
          title: Notification message
        link:
          type: string
          title: Notification link
          maxLength: 500
        sent:
          type: boolean
          title: Message sent ?
        read_at:
          type:
          - string
          - 'null'
          format: date-time
          title: When the notification was read
        dismissed_at:
          type:
          - string
          - 'null'
          format: date-time
          title: When the notification was dismissed
      required:
      - type
    Notification:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          type: string
          title: Message type
          maxLength: 100
        message:
          type: string
          title: Notification message
        link:
          type: string
          title: Notification link
          maxLength: 500
        sent:
          type: boolean
          title: Message sent ?
        created:
          type: string
          format: date-time
          readOnly: true
          title: When the entry was created
        read_at:
          type:
          - string
          - 'null'
          format: date-time
          title: When the notification was read
        dismissed_at:
          type:
          - string
          - 'null'
          format: date-time
          title: When the notification was dismissed
        is_read:
          type: boolean
          readOnly: true
        is_dismissed:
          type: boolean
          readOnly: true
        event:
          allOf:
          - $ref: '#/components/schemas/NotificationEvent'
          readOnly: true
      required:
      - created
      - event
      - id
      - is_dismissed
      - is_read
      - type
    NotificationEvent:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          title: Event name
          maxLength: 255
        slug:
          type: string
          title: Url events
          maxLength: 50
          pattern: ^[-a-zA-Z0-9_]+$
      required:
      - id
      - name
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Access token from `POST /api/v1/auth/jwt/`, refreshed at `POST /api/v1/auth/jwt/refresh/`. Send as `Authorization: Bearer <access>`.'
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
x-refined-from:
- clusterhack-dev-openapi-original.json
- clusterhack-dev-openapi.yml