Skip to content

List the caller's notifications

GET
/api/v1/notifications
curl --request GET \
--url 'https://app.avera.io/api/v1/notifications?includeArchived=false&limit=30&offset=0'

The inbox is recipient-scoped: always the caller’s own. Archived notifications are excluded unless requested, and the page size is capped at 100.

includeArchived
boolean
limit
integer format: int32
default: 30
offset
integer format: int32
0

OK

Media type*/*
Array<object>
object
id
required
string format: uuid
type
required
string
Allowed values: MENTION REPLY COMMENT THREAD_RESOLVED
title
required
string
body
required
string
actorId
string | null format: uuid
itemId
string | null format: uuid
itemNumber
string | null
projectId
string | null format: uuid
threadId
string | null format: uuid
commentId
string | null format: uuid
status
required
string
Allowed values: UNREAD READ ARCHIVED
createdAt
required
string format: date-time
readAt
string | null format: date-time