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

fetch('https://api.example.com/v1/regions/global/notifications/inbox', 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": {
    "requestId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "total": 123,
      "unreadCount": 123,
      "page": 123,
      "pageSize": 123,
      "hasMore": true
    }
  }
}

Authorizations

​
session
string
cookie
required

Session-based authentication via HTTP-only cookie

Query Parameters

​
unreadOnly
boolean
default:false

Show only unread notifications

​
category
enum<string>

Filter by category

Available options:
system,
cluster,
server,
billing,
security,
invitations
​
priority
enum<string>

Filter by priority

Available options:
low,
normal,
high,
urgent
​
limit
number
default:20

Results per page

Required range: 1 <= x <= 100
​
cursor
string

Pagination cursor

Response

Notification inbox

​
success
enum<boolean>
Available options:
true
​
data
object[]
​
meta
object