Notifications

List notifications

List notifications for the authenticated user.

get/api/notifications

Request

  • Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.weavy.com/api/notifications
  • Auth: none declared

Query parameters

actionstring

List notifications that were triggered by actions of this type, e.g. message_created or comment_updated etc.

typeunknown

List notifications of specified type (activity, mention or reaction). When unspecified notifications of all types are listed.

unreadboolean

true lists unread notifications, false lists read notifications. When unspecified notifications are listed whether they are read or not.

directorystring

Directory identifier (id or name). When specified only notifications from apps in the specified directory are listed.

tagstring[]

List notifications with the specified tags. May be specified multiple times to list notifications matching any of the given tags, e.g. tag=a&tag=b.

trashedboolean

Indicates whether trashed notifications should be listed (default is false). Specify null to list both trashed and non-trashed notifications.

order_bystring

Specifies the sort order and direction for the listing, e.g. order_by=id or order_by=id+desc. Properties that can be used for sorting are: id, created_at and read_at.

integer
OR
string int32

The number of items to skip. Used together with take to return a specific range of items (for pagination).

integer
OR
string int32

Maximum number of items to return in the listing. Should be a value between 1 and 100. Default is 25.

count_onlyboolean

true to count the number of matching items instead of listing them; when specified the response will only contain the count property.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.