Sweep

Sweep Notifications API

The Notifications API from Sweep — 3 operation(s) for notifications.

Documentation GitHub OpenAPI

Operations 3

GET /notifications Notifications controller get notifications #

POST /notifications/events/read Notifications controller event read notifications #

POST /notifications/events/read-all Notifications controller event read all notifications #

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/sweep:sweep-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Sweep Notifications API
  description: This is a publicly available Sweep API.
  version: '0.1'
  contact: {}
servers:
- url: https://api.sweep.io
  description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here
tags:
- name: Notifications
paths:
  /notifications:
    get:
      operationId: NotificationsController_getNotifications
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetNotificationsResponseDto'
      security:
      - bearer: []
      tags:
      - Notifications
      summary: Notifications controller get notifications
      x-summary-source: derived
  /notifications/events/read:
    post:
      operationId: NotificationsController_eventReadNotifications
      parameters: []
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Notifications
      summary: Notifications controller event read notifications
      x-summary-source: derived
  /notifications/events/read-all:
    post:
      operationId: NotificationsController_eventReadAllNotifications
      parameters: []
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - Notifications
      summary: Notifications controller event read all notifications
      x-summary-source: derived
components:
  schemas:
    ClientNotificationDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        senderId:
          type: string
          format: uuid
        title:
          type: string
        body:
          type: string
        deepLink:
          type: string
        isRead:
          type: boolean
        createdAt:
          format: date-time
          type: string
      required:
      - id
      - senderId
      - title
      - body
      - deepLink
      - isRead
      - createdAt
    GetNotificationsResponseDto:
      type: object
      properties:
        totalUnread:
          type: number
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/ClientNotificationDto'
      required:
      - totalUnread
      - notifications
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http