Notifications

Get notifications

get

Returns a paginated list of notifications for the user

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Query parameters

pageSizenumber · min: 1 · max: 1000Optional

Number of notifications to return

Default: 100

Responses

200

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

get

/api/public/v1/notifications

HTTPcURLJavaScriptPython

GET /api/public/v1/notifications HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": 200,
  "data": [
    {
      "id": 2,
      "title": "text",
      "text": "text",
      "target": "123e4567-e89b-12d3-a456-426614174000",
      "lang": "en",
      "origin": "text",
      "readStatus": false,
      "createdAt": "2025-06-19T11:35:58.791Z",
      "translations": {}
    }
  ]
}

Create a notification

post

Creates a new notification

Authorizations

bearerAuth

AuthorizationstringRequired

Insert the JWT token here

Body

application/json

titlestringRequired

Notification title

textstringRequired

Notification text

targetstring · uuidRequired

Target user UUID

langstringOptional

Language code (e.g., en)

Default: en

originstring | nullableOptional

Origin of the notification

Default: null

readStatusbooleanOptional

Read status of the notification

Default: false

Responses

201

Default Response

application/json

400

Bad Request

application/json

401

Unauthorized - The request requires a valid Bearer token.

	To access this endpoint:

    1. Make a POST request to /api/public/v1/auth with valid credentials to obtain the access token.
    2. Click the "Authorize" button in the Swagger UI and enter the token.
    3. All protected endpoints require the Authorization header: "Authorization: 'Bearer your-access-token'"

application/json

500

Internal Server Error

application/json

503

Service Unavailable — Connection Refused

application/json

post

/api/public/v1/notifications

HTTPcURLJavaScriptPython

POST /api/public/v1/notifications HTTP/1.1
Host: hostname
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "title": "New Mention",
  "text": "Data_Steward mentioned you in a comment on AWS S3 LDC Test_1.",
  "target": "0081abdb-7904-400b-aaac-e1a2365192a0"
}

{
  "status": 201,
  "message": "Notification Created"
}