Path parameters

• spotMemberId string Required

  The id of the Spot member

Query parameters

• before string

  To list elements before a specific ID

• after string

  To list elements after a specific ID

• limit number

  The limit of results to be returned

• types[in] array[string]

  The types of notifications to include in the result

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

• isRead[eq] boolean

  List notifications read or unread

Responses

• 200 application/json

  Notifications returned successfully

  Hide response attributes Show response attributes object

  • items array[object] Required

    The items found

    Hide items attributes Show items attributes object

    • id string Required

      The id of the notification.

    • userId string Required

      The user id of the notification.

    • logId string Required

      The log id of the notification.

    • isRead boolean Required

      To know if notification was read

    • createdAt string(date-time) Required

      The creation date of the notification.

    • log object | null Required
      Hide log attributes Show log attributes object | null

      • id string Required

        The id of the notification log.

      • spotId string Required

        The spot id of the notification log.

      • type string Required

        The type of the notification log.

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

      • body object Required

        The body of the notification log.

  • hasMore boolean Required

    Indicate if more items are available

• 400

  Malformed payload

• 404

  Spot member not found