Endpoints - Notifications

List notifications

List notifications

GEThttps://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/notifications

Path parameters

spotMemberId*string

The id of the Spot member

Query parameters

Response

200400404

Notifications returned successfully

Body

application/json

items*array of NotificationApiResponse (object)

The items found

hasMore*boolean

Indicate if more items are available

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "userId": "text",
      "logId": "text",
      "isRead": false,
      "createdAt": "2024-11-21T09:28:36.238Z",
      "log": {
        "id": "text",
        "spotId": "text",
        "type": "AskJoinPrivateSpot"
      }
    }
  ],
  "hasMore": false
}

Mark notifications as read

Mark notifications as read

POSThttps://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/notifications~markAsRead

Path parameters

spotMemberId*string

The id of the Spot member

Body

application/json

idall of

Filters on notifications to include

Response

200400

Notifications successfully marked as read

Body

application/json

id*string

The id of the notification.

userId*string

The user id of the notification.

logId*string

The log id of the notification.

isRead*boolean

To know if notification was read

createdAt*string (date-time)

The creation date of the notification.

log*nullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/notifications~markAsRead', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "userId": "text",
    "logId": "text",
    "isRead": false,
    "createdAt": "2024-11-21T09:28:36.238Z",
    "log": {
      "id": "text",
      "spotId": "text",
      "type": "AskJoinPrivateSpot"
    }
  }
]

Get unread notifications count

Get unread notifications count

GEThttps://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/notifications~unreadCount

Path parameters

spotMemberId*string

The id of the Spot member

Query parameters

Response

200400404

Counter of unread notification returned successfully

Body

application/json

count*number

Sum of counters

countByTypes*array of UnreadNotificationsCountByTypeApiResponse (object)

Unread notifications by types

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/notifications~unreadCount', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 0,
  "countByTypes": [
    {
      "type": "AskJoinPrivateSpot",
      "count": 0
    }
  ]
}