List the latest notifications for the dashboard

GET

/users/{user}/dashboard/notifications

const url = 'https://work.optidata.cloud/api/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dashboard/notifications';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://work.optidata.cloud/api/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/dashboard/notifications \
  --header 'Authorization: Bearer <token>'

The most recent notifications of the user, already rendered in their locale and time zone. Notifications whose message cannot be rendered are dropped rather than returned empty. The number of items is fixed by the dashboard card configuration.

Authorizations

bearerAuth

Parameters

Path Parameters

user

required

string format: uuid

UUID of the dashboard owner.

Responses

200

Latest notifications.

application/json

Array<object>

One notification delivered to a user, or a tenant-wide announcement.

object

integer format: int64

uuid

Recipient. null on tenant-wide announcements.

string | null format: uuid

is_read

boolean

created_at

string format: date-time

notification

The underlying notification, enriched with a rendered message.

object

integer format: int64

key

string

resolved_message

Localised, plain-text rendering of the notification.

string

actor

string | null

icon

string | null

app_name

string | null

key

additional properties

any

Example

[
  {
    "notification": {
      "key": "drive.share.permission_created"
    }
  }
]

401

Missing, malformed or expired authentication key.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

missing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

429

Rate limit exceeded. Retry after the window resets.

application/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

throttled

{
  "message": "Too Many Attempts."
}