🗃️Endpoints - Notifications

List notifications

get

List notifications

Paramètres de chemin
spotMemberIdstringRequis

The id of the Spot member

Paramètres de requête
beforestringOptionnel

To list elements before a specific ID

afterstringOptionnel

To list elements after a specific ID

limitnumberOptionnel

The limit of results to be returned

isRead[eq]booleanOptionnel

List notifications read or unread

Réponses
200
Notifications returned successfully
application/json
get
GET /v1/spotMembers/{spotMemberId}/notifications HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "items": [
    {
      "id": "text",
      "userId": "text",
      "logId": "text",
      "isRead": true,
      "createdAt": "2025-06-23T06:00:16.105Z",
      "log": {
        "id": "text",
        "spotId": "text",
        "type": "AskJoinPrivateSpot",
        "body": {}
      }
    }
  ],
  "hasMore": true
}

Mark notifications as read

post

Mark notifications as read

Paramètres de chemin
spotMemberIdstringRequis

The id of the Spot member

Corps
idall ofOptionnel

Filters on notifications to include

Réponses
200
Notifications successfully marked as read
application/json
post
POST /v1/spotMembers/{spotMemberId}/notifications~markAsRead HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "id": {
    "id[in]": [
      "text"
    ]
  }
}
[
  {
    "id": "text",
    "userId": "text",
    "logId": "text",
    "isRead": true,
    "createdAt": "2025-06-23T06:00:16.105Z",
    "log": {
      "id": "text",
      "spotId": "text",
      "type": "AskJoinPrivateSpot",
      "body": {}
    }
  }
]

Get unread notifications count

get

Get unread notifications count

Paramètres de chemin
spotMemberIdstringRequis

The id of the Spot member

Paramètres de requête
Réponses
200
Counter of unread notification returned successfully
application/json
get
GET /v1/spotMembers/{spotMemberId}/notifications~unreadCount HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
  "count": 1,
  "countByTypes": [
    {
      "type": "AskJoinPrivateSpot",
      "count": 1
    }
  ]
}

Dernière mise à jour

Cet article vous a-t-il été utile ?