Get notifications by the user authorized

Get notifications by the user authorized.

get

Query parameters

TitlestringOptional

The title of the notification.

ContentstringOptional

The content of the notification.

ActionUrlstringOptional

The action url of the notification.

CategorystringOptional

The category of the notification.

TopicstringOptional

The topic of the notification.

TestModebooleanOptional

Flag to indicate if the notification is in test mode.

Statusstring · enumOptional

The status of the notification.

Possible values:

SortDataFieldstringOptional

The sort data field of the pagination.

SortOrderstringOptional

The sort order of the pagination.

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/notifications HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "example-id",
        "emailSubject": "Example Notification",
        "title": "Example Notification",
        "emailBody": "This is an example notification content.",
        "content": "This is an example notification content.",
        "actionURL": "https://example.com/action",
        "category": "Example Category",
        "topic": "Example Topic",
        "sentTime": "2025-06-23T13:56:00.5914608+07:00",
        "seenAt": "2025-06-23T13:56:00.5914609+07:00",
        "status": "Unread",
        "testMode": false,
        "createdDate": "2025-06-23T13:56:00.5914598+07:00"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null,
    "unreadCount": 1
  },
  "errors": []
}