GET Get Notifications¶
Endpoint¶
GET /notify/list
Description¶
Returns notifications for the authenticated client account.
This endpoint is available only for SESSION_USER.
Important behavior:
- only notifications with
user_id = current account loginare returned - global manager broadcasts with
user_id = 0are not returned here - filtering is applied against the notification message payload
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| limit | int | Yes | Maximum number of rows to return |
| offset | int | Yes | Pagination offset |
| filter | string | Yes | Text filter applied to notification message |
Request Example¶
GET /notify/list?limit=20&offset=0&filter=margin
Authorization: Bearer <JWT_TOKEN>
Response Parameters¶
| Name | Type | Description |
|---|---|---|
| structure | array | Ordered field list used in each row |
| rows | array | Notification rows |
Each row contains:
idtokenmessagecreate_timeopen_timetypestatusleveldescriptiondata
Response Example¶
{
"structure": ["id", "token", "message", "create_time", "open_time", "type", "status", "level", "description", "data"],
"rows": [
[
101,
"MARGIN_CALL",
{ "title": "Margin call", "body": "Your margin level is below threshold" },
1734312345,
0,
2,
1,
1,
{},
{ "level": 87.2 }
]
]
}