Notifications

Get notifications for the authenticated user

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptional

Maximum number of records to return (maximum 100)

Example: 50

startDatestringOptional

Filter notifications created on/after this time (ISO or ms)

Example: 2024-01-01T00:00:00.000Z

endDatestringOptional

Filter notifications created on/before this time (ISO or ms)

Example: 2024-12-31T23:59:59.999Z

Responses

200

Notifications retrieved successfully

application/json

object[]Optional

get/notifications

HTTPcURLJavaScriptPython

GET /notifications HTTP/1.1
Host: hl-v2.pearprotocol.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Notifications retrieved successfully

[
  {}
]

Mark a notification by id as read or all up to a timestamp (ms)

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringOptional

Notification id to mark as read (takes precedence if provided).

timestampnumberOptional

Unix timestamp in milliseconds. Marks notifications created at or before this time as read.

Responses

200

Number of notifications updated

application/json

objectOptional

post/notifications/read

HTTPcURLJavaScriptPython

POST /notifications/read HTTP/1.1
Host: hl-v2.pearprotocol.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "id": "text",
  "timestamp": 1
}

200

Number of notifications updated

{}