Get notifications

Gets notifications for a user based on the type

GET /api/v1/notifications

Error

A valid request URL is required to generate request examples

200

{
  "results": [
    {
      "viewed": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "notificationId": "<string>",
      "resourceType": "dashboardComments",
      "url": "<string>",
      "message": "<string>",
      "resourceUuid": "<string>",
      "metadata": {
        "dashboardUuid": "<string>",
        "dashboardName": "<string>",
        "dashboardTileUuid": "<string>",
        "dashboardTileName": "<string>"
      }
    }
  ],
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Query Parameters

type · enum<string> · required

Available options: dashboardComments, aiReview

Response

200

application/json

Success

results · object[] · required

Option 1

Option 2

Show child attributes

status · enum<string> · required

Available options: ok