subscriptions

Get all notifications for the current user

Returns an array with all notifications for the current user. Notifications about a project the current user can no longer read are omitted; the filtering happens in the query, so paging and the x-pagination-* headers all describe the visible notifications only.

get/notifications

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/notifications
  • Auth
    API key in header Authorization

Query parameters

pageinteger

The page number. Used for pagination. If not provided, the first page of results is returned.

per_pageinteger

The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Response

The notifications

createdstring

A timestamp when this notification was created. You cannot change this value.

idinteger

The unique, numeric id of this notification.

namestring

The name of the notification

notificationunknown
read_atstring

When this notification is marked as read, this will be updated with the current timestamp.

Changes

No recorded changes to this operation across all 74 revisions of this API.