Skip to main content
GET
/
v1
/
notifications
List notifications
curl --request GET \
  --url http://localhost:3000/v1/notifications
{
  "notifications": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "title": "<string>",
      "body": "<string>",
      "status": "<string>",
      "category": "<string>",
      "priority": "<string>",
      "created_at": "<string>",
      "read_at": "<string>",
      "dismissed_at": "<string>",
      "data": "<unknown>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Query Parameters

userId
string<uuid>
status
string
type
string
category
string
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer | null
default:0
Required range: x >= 0

Response

200 - application/json

List of notifications

notifications
object[]
required
total
number
required
limit
number
required
offset
number
required