Get a notification related to a user

Get a notification detail by the given userId and notificationId.

get
Path parameters
userIdstringRequired

The id of the user.

notificationIdstringRequired

The id of the notification.

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
get
GET /api/v1/users/{userId}/notifications/{notificationId} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*
{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "title": "Title",
    "type": "Segment",
    "channel": "InApp",
    "content": "Content",
    "actionURL": "https://example.com/action",
    "category": "Category",
    "topic": "Topic",
    "sentTime": "2025-09-12T15:18:49.802582+07:00",
    "seenAt": "2025-09-12T15:18:49.802583+07:00",
    "metadata": null,
    "scheduledDate": null,
    "status": "ReadEmailNotification",
    "testMode": true
  },
  "errors": []
}

Last updated

Was this helpful?