Skip to main content
GET
List my notifications

Authorizations

x-api-key
string
header
required

Headers

x-signature
string

HMAC-SHA256 signature: HMAC-SHA256(secretKey, timestamp + METHOD + path + body). Required for API-key authenticated requests (JWT/OAuth session auth is exempt).

x-timestamp
string

Request timestamp in epoch milliseconds. Required with x-signature for API-key auth. Rejected if drift exceeds 5 minutes.

Query Parameters

limit
number
default:20

Page size (max 100)

offset
number
default:0
order
enum<string>
default:DESC
Available options:
ASC,
DESC
orderBy
enum<string>
default:_id
Available options:
_id,
sendsAt,
markAsRead
query
string

Search in title and body (same as GraphQL filter.query)

types
string

Comma-separated NotificationType values (e.g. NEW_PICKS,WALLET_UPDATE)

unreadOnly
boolean

true = unread only, false = read only, omit = all

Response

Paginated notifications with unread total.

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload