Notifications API

v1.0 • REST • JSON

Full CRUD management for notification accounts. Create, retrieve, update, and delete notification records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/notifications

Quick Reference

GET
/api/notifications List all notifications (paginated)
200 GET
/api/notifications/{id} Get one notification by ID
200 POST
/api/notifications Create a new notification
201 PUT
/api/notifications/{id} Replace notification data
204 DEL
/api/notifications/{id} Remove a notification
204 GET
/api/notifications/{id} Notification not found example
404
GET /api/notifications 200 OK

Get All Notifications

Retrieves a paginated list of all notifications in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/notifications/{id} 200 OK

Get Single Notification

Fetch the full profile for a specific notification using their numeric ID. Returns all notification fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique notification identifier
Response: 200 OK
GET /api/notifications/{id} 404 Not Found

Notification Not Found

Returned when the requested notification ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing notification resources.

Response: 404 Not Found
POST /api/notifications 201 Created

Create Notification

Registers a new notification with the provided details. On success, returns the newly created notification object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
userId integer Optional User id
title string Required Title
message string Required Message
type string Required Type
isRead boolean Required Is read
Body
Response: 201 Created
PUT /api/notifications/{id} 200 OK

Update Notification

Fully replaces an existing notification's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
userId integer Optional User id
title string Required Title
message string Required Message
type string Required Type
isRead boolean Required Is read
Body
Response: 200 OK
DELETE /api/notifications/{id} 204 No Content

Delete Notification

Permanently removes a notification from the system by their ID. This action is irreversible once deleted, the notification record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the notification to delete
Response: 204 No Content