gitpod.v1.NotificationService

ListNotifications

Lists notifications for the authenticated user. Response includes unread_count and total_count for the inbox badge.

Examples

  • List all notifications:

    pagination:
      pageSize: 20
    
  • List unread notifications:

    pagination:
      pageSize: 20
    read: false
    
post/gitpod.v1.NotificationService/ListNotifications

Query parameters

pageSizeinteger
tokenstring

Request body

readboolean nullable

Filter by read status. If not set, returns all notifications.

typesGitpodV1NotificationType[]

Filter by notification types. If empty, returns all types.

Response

Success

notificationsGitpodV1Notification[] — unresolved $ref
totalCountinteger
unreadCountinteger

Counts for the inbox badge. Always returned regardless of filters.

Changes