Get notifications from a user

Get notifications by the user's id.

get

Path parameters

userIdstringRequired

The id of the user to get.

Query parameters

Statusstring · enumOptional

The status of the notification.

Possible values:

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

The sort order to sort. By default, the value is Descending.

Possible values:

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

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId}/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",
        "title": "Example Notification",
        "type": "Segment",
        "channel": "Unknown",
        "content": "This is an example notification content.",
        "actionURL": "https://example.com/action",
        "category": "Example Category",
        "topic": "Example Topic",
        "sentTime": "2025-08-19T10:03:56.194227+07:00",
        "seenAt": "2025-08-19T10:03:56.194227+07:00",
        "metadata": null,
        "scheduledDate": null,
        "status": "Unread",
        "testMode": false,
        "createdDate": "2025-08-19T10:03:56.194226+07:00"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null,
    "unreadCount": 1
  },
  "errors": []
}