Перейти к содержимому

List Notifications

GET
/v1/notifications
curl --request GET \
--url 'https://api.cloud.agentums.ru/v1/notifications?unread=false&limit=50' \
--header 'Authorization: Bearer <token>'

Уведомления владельца; unread=true — только непрочитанные.

Push-канала у API нет: клиент забирает уведомления опросом. Ответ несёт счётчик непрочитанных, поэтому бейдж рисуется без второго запроса.

unread
Unread
boolean
limit
Limit
integer
default: 50 >= 1 <= 100

Successful Response

Media typeapplication/json
NotificationList
object
items
required
Items
Array<object>
NotificationOut
object
body
Body
string
""
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
kind
required
Kind
string
payload
Payload
object
key
additional properties
any
read_at
Any of:
string format: date-time
title
required
Title
string
unread
Unread
integer
0
Example
{
"items": [
{
"body": "",
"payload": {}
}
],
"unread": 0
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}