notifications

List notification history

get/api/v1/notifications

Query parameters

status'unread' | 'all' | 'unresolved'

Notification filter. Defaults to unread (unseen); unresolved returns notifications whose underlying issue is still open; all includes read history.

Notification filter. Defaults to unread (unseen); unresolved returns notifications whose underlying issue is still open; all includes read history.

limitinteger

Maximum notifications to return. Defaults to 100.

Maximum notifications to return. Defaults to 100.

cursorstring

Opaque cursor returned by the previous page.

Opaque cursor returned by the previous page.

Response

OK

nextCursorstring
unreadCountinteger required
unresolvedCountinteger required

Changes

Changed in 4 of the 107 revisions of this API.18

    • added the new enum value unresolved to the query request parameter status

      request-parameter-enum-value-added

    • added the optional property notifications/items/resolvedAt to the response with the 200 status

      response-optional-property-added

    • added the required property unresolvedCount to the response with the 200 status

      response-required-property-added

    • added the new optional query request parameter cursor

      new-optional-request-parameter

    • added the new enum value all to the query request parameter status

      request-parameter-enum-value-added

    • added the optional property nextCursor to the response with the 200 status

      response-optional-property-added

    • added the required property unreadCount to the response with the 200 status

      response-required-property-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 37 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog