API
GET /v1/spotMembers/{spotMemberId}/notifications~unreadCount

Get unread notifications count

Path parameters

  • spotMemberId string Required

    The id of the Spot member

Query parameters

  • types[in] array[string]

    The types of notifications to include in the result

    Values are AskJoinPrivateSpot, ChannelMessageMention, ChannelMessageReported, CourseGeneratedFailed, CourseGeneratedSuccess, CourseParticipantInvited, DiscussionMessageReported, DocumentMention, HubspotConnectionLost, LearningPathParticipantInvited, LiveMention, LiveMessageMention, LiveMessageReported, LiveParticipantInvited, LiveStarted, MemberAddedOnChannel, MemberAddedToForum, MemberAddedToCollection, MessageReplied, NewDirectMessage, NewMessage, ReportStatusUpdated, SmtpServerConnectionFailed, SpotMemberRoleUpdated, SpotMention, TopicAnswerReported, TopicCreated, TopicMention, TopicMessageCreated, TopicMessageMention, TopicReported, UserInvitedToSpot, or UserJoinedPublicSpot.

Responses

  • 200 application/json

    Counter of unread notification returned successfully

    Hide response attributes Show response attributes object
    • count number Required

      Sum of counters

    • countByTypes array[object] Required

      Unread notifications by types

      Hide countByTypes attributes Show countByTypes attributes object
      • type string Required

        Type of notification

        Values are AskJoinPrivateSpot, ChannelMessageMention, ChannelMessageReported, CourseGeneratedFailed, CourseGeneratedSuccess, CourseParticipantInvited, DiscussionMessageReported, DocumentMention, HubspotConnectionLost, LearningPathParticipantInvited, LiveMention, LiveMessageMention, LiveMessageReported, LiveParticipantInvited, LiveStarted, MemberAddedOnChannel, MemberAddedToForum, MemberAddedToCollection, MessageReplied, NewDirectMessage, NewMessage, ReportStatusUpdated, SmtpServerConnectionFailed, SpotMemberRoleUpdated, SpotMention, TopicAnswerReported, TopicCreated, TopicMention, TopicMessageCreated, TopicMessageMention, TopicReported, UserInvitedToSpot, or UserJoinedPublicSpot.

      • count number Required

        Number of unread notifications
  • 400

    Malformed payload

  • 404

    Spot member not found

GET /v1/spotMembers/{spotMemberId}/notifications~unreadCount 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/notifications~unreadCount'
Response examples (200) 
{
  "count": 42.0,
  "countByTypes": [
    {
      "type": "AskJoinPrivateSpot",
      "count": 42.0
    }
  ]
}