Skip to main content
GET
/
v1
/
regions
/
global
/
notifications
/
inbox
/
{id}
Get notification
const options = {method: 'GET', headers: {cookie: 'session='}};

fetch('https://api.example.com/v1/regions/global/notifications/inbox/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": {
    "id": "<string>",
    "category": "system",
    "priority": "low",
    "title": "<string>",
    "message": "<string>",
    "read": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "resourceType": "<string>",
    "resourceId": "<string>",
    "actionUrl": "<string>",
    "clickActionUrl": "<string>",
    "primaryActionLabel": "<string>",
    "primaryActionUrl": "<string>",
    "secondaryActionLabel": "<string>",
    "secondaryActionUrl": "<string>",
    "readAt": "2023-11-07T05:31:56Z"
  },
  "meta": {}
}

Authorizations

session
string
cookie
required

Session-based authentication via HTTP-only cookie

Path Parameters

id
string
required

Response

Notification details

success
enum<boolean>
Available options:
true
data
object

Notification entity

meta
object