Get All Notifications

GET /notifications/list

Get All Notifications

cURL

curl --request GET \
  --url https://www.api.baselink.tech/notifications/list \
  --header 'bearer: <api-key>'

200

{
  "notifications": [
    {}
  ],
  "notifications[].id": "<string>",
  "notifications[].userId": "<string>",
  "notifications[].type": "<string>",
  "notifications[].title": "<string>",
  "notifications[].message": "<string>",
  "notifications[].read": 123,
  "notifications[].expiresAt": 123,
  "notifications[].metadata": {},
  "notifications[].teamId": "<string>",
  "notifications[].commitId": "<string>",
  "notifications[].repository": "<string>",
  "notifications[].repositoryId": "<string>",
  "notifications[].createdAt": "<string>"
}

Retrieve all notifications in the system. This endpoint is restricted to admin users only.

notifications · array

Array of all notification objects in the system.

notifications[].id · string

The unique identifier of the notification.

notifications[].userId · string

The ID of the user who received the notification.

notifications[].type · string

The type of notification.

notifications[].title · string

The title of the notification.

notifications[].message · string

The message content of the notification.

notifications[].read · number

Whether the notification has been read (1) or not (0).

notifications[].expiresAt · number

The expiration timestamp of the notification.

notifications[].metadata · object

Additional metadata for the notification.

notifications[].teamId · string

The team ID associated with the notification.

notifications[].commitId · string

The commit ID associated with the notification.

notifications[].repository · string

The repository name associated with the notification.

notifications[].repositoryId · string

The repository ID associated with the notification.

notifications[].createdAt · string

The creation timestamp of the notification.