Skip to main content
GET
/
v1
/
arc
/
notifications
/
notifications
/
inbox
List inbox notifications
const options = {method: 'GET'};

fetch('http://localhost:4005/v1/arc/notifications/notifications/inbox', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "category": "<string>",
      "priority": "<string>",
      "title": "<string>",
      "message": "<string>",
      "resourceType": "<string>",
      "resourceId": "<string>",
      "actionUrl": "<string>",
      "clickActionUrl": "<string>",
      "primaryActionLabel": "<string>",
      "primaryActionUrl": "<string>",
      "secondaryActionLabel": "<string>",
      "secondaryActionUrl": "<string>",
      "read": true,
      "readAt": "<string>",
      "createdAt": "<string>"
    }
  ],
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>",
    "pagination": {
      "total": 123,
      "pageSize": 123,
      "hasMore": true
    },
    "unreadCount": 123
  }
}

Query Parameters

unreadOnly
string
category
string
priority
string
scope
enum<string>

Filter by notification scope: "user" (notifications where current user is subject), "users" (all user-scoped notifications), "organization" (organization-scoped), "all" (no scope filter)

Available options:
user,
users,
organization,
all
limit
string
cursor
string

Response

Notification inbox

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