NimbusNexus V1:account:notifications API
The v1:account:notifications API from NimbusNexus — 5 operation(s) for v1:account: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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/nimbusnexus:nimbusnexus-v1-account-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: NimbusNexus API — External V1:account:notifications API
description: 'External (public) API intended for client-facing integrations and the web portal.
Authentication:
- This API uses JWT Bearer authentication.
- In Swagger UI, click ''Authorize'' and sign in via the configured token endpoint.
- Swagger will automatically attach the header: Authorization: Bearer .'
version: test
servers:
- url: /
description: Current host
- url: https://fastapi.dev.nimbusnexus.net
description: Development
security:
- SwaggerLogin: []
- ApiKeyAuth: []
tags:
- name: v1:account:notifications
paths:
/api/v1/notifications/websocket-info:
get:
tags:
- v1:account:notifications
summary: WebSocket connection guide
description: '## WebSocket Endpoint
`wss:///api/v1/ws`
This endpoint establishes a persistent WebSocket connection used to receive real-time notifications.
---
## Authentication
Authentication is required.
JWT token must be provided in **HTTP headers** during the WebSocket handshake:'
operationId: we_info_api_v1_notifications_websocket_info_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WebSocketInfoResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/notifications/list:
get:
tags:
- v1:account:notifications
summary: Get Notifications List
description: List the calling user's notifications with filtering by delivery status, metadata and pagination.
operationId: get_notifications_list_api_v1_notifications_list_get
security:
- SwaggerLogin: []
- ApiKeyAuth: []
parameters:
- name: id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Id
- name: statuses
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Statuses
- name: notification_types
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Notification Types
- name: workspace_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Workspace Id
- name: meta_data_key
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Meta Data Key
- name: meta_data_value
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Meta Data Value
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: limit
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
default: 50
title: Limit
- name: sort_by
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
default: created_at
title: Sort By
- name: sort_desc
in: query
required: false
schema:
type: boolean
default: true
title: Sort Desc
- name: provide_workspace_id
in: query
required: false
schema:
type: boolean
default: true
title: Provide Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationSuccessSuccessOutList'
'400':
description: Bad Request
content:
application/json:
example:
success: false
message: Bad Request
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'401':
description: Unauthorized
content:
application/json:
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
'422':
description: Validation error
content:
application/json:
example:
success: false
errors:
field:
- Invalid value
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
'500':
description: Internal Server Error
content:
application/json:
example:
success: false
message: Internal Server Error
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
/api/v1/notifications/:
post:
tags:
- v1:account:notifications
summary: Create Notification
description: Create a new in-app notification addressed to the calling user in the current scope.
operationId: create_notification_api_v1_notifications__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCreateIn'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationSuccessOutCreate'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
delete:
tags:
- v1:account:notifications
summary: Delete Notification
description: Delete a single notification by ID.
operationId: delete_notification_api_v1_notifications__delete
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteNotification'
required: true
responses:
'204':
description: Successful Response
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Not Found
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
patch:
tags:
- v1:account:notifications
summary: Update Notification
description: Update a single notification (for example to mark it as read) and return the updated record.
operationId: update_notification_api_v1_notifications__patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationUpdate'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationSuccessOutCreate'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Not Found
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/notifications/create_for_admins:
post:
tags:
- v1:account:notifications
summary: Create Notification For Admins
description: Broadcast a notification to all administrators of the targeted scope.
operationId: create_notification_for_admins_api_v1_notifications_create_for_admins_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdminNotificationCreateIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AdminNotificationCreateOut'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Forbidden
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
/api/v1/notifications/bulk:
delete:
tags:
- v1:account:notifications
summary: Delete Notification Bulk
description: Delete many notifications in a single transaction; reports any IDs that were not found.
operationId: delete_notification_bulk_api_v1_notifications_bulk_delete
requestBody:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DeleteNotification'
type: array
title: Json Body
required: true
responses:
'204':
description: Successful Response
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Forbidden
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
patch:
tags:
- v1:account:notifications
summary: Update Notifications Bulk
description: Update many notifications in a single transaction; reports any IDs that were not found.
operationId: update_notifications_bulk_api_v1_notifications_bulk_patch
requestBody:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/NotificationUpdate'
type: array
title: Json Body
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationSuccessSuccessOutUpdateBulk'
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseValidationErrorOut'
example:
success: false
errors:
field:
- Invalid value
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Bad Request
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Unauthorized | Invalid token | Expired token | Authentication required
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Forbidden
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Not Found
'409':
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Conflict
'429':
description: Too Many Requests
headers:
Retry-After:
description: Seconds to wait before retrying the request
schema:
type: string
example: '30'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
code: 429
message: Too many requests
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBaseErrorOut'
example:
success: false
message: Internal Server Error
security:
- SwaggerLogin: []
- ApiKeyAuth: []
components:
schemas:
NotificationSuccessSuccessOutList:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/NotificationServiceCreate'
type: array
title: Data
total:
type: integer
title: Total
unread_count:
type: integer
title: Unread Count
type: object
required:
- data
- total
- unread_count
title: NotificationSuccessSuccessOutList
NotificationServiceCreate:
properties:
notification_type:
allOf:
- $ref: '#/components/schemas/NotificationTypeEnum'
default: email_always
message:
type: string
minLength: 1
title: Message
delivery_status:
allOf:
- $ref: '#/components/schemas/DeliveryStatusEnum'
default: pending
is_email_sent:
type: boolean
title: Is Email Sent
default: false
title:
type: string
title: Title
visual_type:
allOf:
- $ref: '#/components/schemas/VisualTypeEnum'
default: info
has_actions:
type: boolean
title: Has Actions
default: false
meta_data:
anyOf:
- type: object
- type: 'null'
title: Meta Data
id:
type: string
title: Id
user_id:
type: string
title: User Id
workspace_id:
anyOf:
- type: string
- type: 'null'
title: Workspace Id
workspace_name:
anyOf:
- type: string
- type: 'null'
title: Workspace Name
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
project_name:
anyOf:
- type: string
- type: 'null'
title: Project Name
created_at:
type: string
format: date-time
title: Created At
type: object
required:
- message
- title
- user_id
title: NotificationServiceCreate
NotificationSuccessSuccessOutUpdateBulk:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/NotificationServiceCreate'
type: array
title: Data
type: object
required:
- data
title: NotificationSuccessSuccessOutUpdateBulk
NotificationCreateIn:
properties:
notification_type:
allOf:
- $ref: '#/components/schemas/NotificationTypeEnum'
default: email_always
message:
type: string
minLength: 1
title: Message
delivery_status:
allOf:
- $ref: '#/components/schemas/DeliveryStatusEnum'
default: pending
is_email_sent:
type: boolean
title: Is Email Sent
default: false
title:
type: string
title: Title
visual_type:
allOf:
- $ref: '#/components/schemas/VisualTypeEnum'
default: info
has_actions:
type: boolean
title: Has Actions
default: false
meta_data:
anyOf:
- type: object
- type: 'null'
title: Meta Data
type: object
required:
- message
- title
title: NotificationCreateIn
DeliveryStatusEnum:
type: string
enum:
- pending
- unread
- read
title: DeliveryStatusEnum
NotificationSuccessOutCreate:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/NotificationServiceCreate'
type: object
required:
- data
title: NotificationSuccessOutCreate
AdminNotificationCreateOut:
properties:
success:
type: boolean
title: Success
default: true
data:
items:
$ref: '#/components/schemas/NotificationServiceCreate'
type: array
title: Data
type: object
required:
- data
title: AdminNotificationCreateOut
NotificationTypeEnum:
type: string
enum:
- email_if_unread
- email_always
title: NotificationTypeEnum
WebsocketNotificationOut:
properties:
success:
type: boolean
title: Success
default: true
data:
$ref: '#/components/schemas/WebsocketNotification'
type: object
required:
- data
title: WebsocketNotificationOut
AdminNotificationCreateIn:
properties:
project_id:
anyOf:
- type: string
- type: 'null'
title: Project Id
workspace_id:
anyOf:
- type: string
- type: 'null'
title: Workspace Id
notification_type:
allOf:
- $ref: '#/components/schemas/NotificationTypeEnum'
default: email_always
message:
type: string
title: Message
delivery_status:
allOf:
- $ref: '#/components/schemas/DeliveryStatusEnum'
default: pending
created_at:
type: string
format: date-time
title: Created At
is_email_sent:
type: boolean
title: Is Email Sent
default: false
title:
type: string
title: Title
visual_type:
allOf:
- $ref: '#/components/schemas/VisualTypeEnum'
default: info
has_actions:
type: boolean
title: Has Actions
default: false
meta_data:
anyOf:
- type: object
- type: 'null'
title: Meta Data
type: object
required:
- message
- title
title: AdminNotificationCreateIn
ResponseBaseErrorOut:
properties:
success:
type: boolean
title: Success
default: false
message:
type: string
title: Message
type: object
required:
- message
title: ResponseBaseErrorOut
VisualTypeEnum:
type: string
enum:
- info
- system
- invite
- payment
- billing
- warning
- critical
- resize
title: VisualTypeEnum
WebSocketInfoResponse:
properties:
url:
type: string
title: Url
default: wss://api.example.com/api/v1/ws
authentication:
type: string
title: Authentication
default: 'JWT token must be passed in headers as Authorization: Bearer <token>'
message_data:
allOf:
- $ref: '#/components/schemas/WebsocketNotificationOut'
default:
success: true
data:
created_at: '2026-02-18T11:20:45.123456Z'
delivery_status: pending, unread, read
domain_id: domain_456
has_actions: true
id: f4b2c7e8d1a34b2f8c9d1234567890ab
is_email_sent: false
message: Your resource has been created successfully
meta_data:
key: value
notification_type: email_if_unread, email_always
title: New Notification
user_id: user_123
visual_type: info, system, invite, payment, billing, warning, critical, resize
type: object
title: WebSocketInfoResponse
ResponseValidationErrorOut:
properties:
success:
type: boolean
title: Success
default: false
errors:
additionalProperties:
items:
type: string
type: array
type: object
title: Errors
type: object
required:
- errors
title: ResponseValidationErrorOut
NotificationUpdate:
properties:
id:
type: string
title: Id
notification_type:
anyOf:
- $ref: '#/components/schemas/NotificationTypeEnum'
- type: 'null'
message:
anyOf:
- type: string
- type: 'null'
title: Message
delivery_status:
anyOf:
- $ref: '#/components/schemas/DeliveryStatusEnum'
- type: 'null'
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
is_email_sent:
anyOf:
- type: boolean
- type: 'null'
title: Is Email Sent
title:
anyOf:
- type: string
- type: 'null'
title: Title
visual_type:
anyOf:
- $ref: '#/components/schemas/VisualTypeEnum'
- type: 'null'
has_actions:
anyOf:
- type: boolean
- type: 'null'
title: Has Actions
meta_data:
anyOf:
- type: object
- type: 'null'
title: Meta Data
type: object
required:
- id
title: NotificationUpdate
WebsocketNotification:
properties:
id:
type: string
title: Id
user_id:
type: string
title: User Id
domain_id:
anyOf:
- type: string
- type: 'null'
title: Domain Id
created_at:
type: string
format: date-time
title: Created At
notification_type:
type: string
title: Notification Type
message:
type: string
minLength: 1
title: Message
delivery_status:
type: string
title: Delivery Status
is_email_sent:
type: boolean
title: Is Email Sent
default: false
title:
type: string
title: Title
visual_type:
type: string
title: Visual Type
has_actions:
type: boolean
title: Has Actions
default: false
meta_data:
anyOf:
- type: object
- type: 'null'
title: Meta Data
type: object
required:
- user_id
- notification_type
- message
- delivery_status
- title
- visual_type
title: WebsocketNotification
DeleteNotification:
properties:
id:
type: string
minLength: 1
title: Id
type: object
required:
- id
title: DeleteNotification
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key
SwaggerLogin:
type: oauth2
flows:
password:
tokenUrl: /api/v1/account/login_swagger
scopes: {}
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API Key format - base64('<id>:<secret>')