Reference
Notifications
List Notifications
Query Parameters
limit?integer
Default
25Range
1 <= value <= 100cursor?|
unread?|
kinds?array<>|
includeCleared?boolean
Default
falseHeader Parameters
authorization?|
X-API-Key?|
Cookie Parameters
vai_token?|
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/notifications"{
"items": [
{
"body": "string",
"clearedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"id": "string",
"kind": "string",
"link": "string",
"readAt": "2019-08-24T14:15:22Z",
"title": "string"
}
],
"nextCursor": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Mark All Notifications Read
Header Parameters
authorization?|
X-API-Key?|
Cookie Parameters
vai_token?|
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/notifications/read-all"{
"marked": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Unread Count
Header Parameters
authorization?|
X-API-Key?|
Cookie Parameters
vai_token?|
Response Body
application/json
application/json
curl -X GET "https://loading/api/v1/notifications/unread-count"{
"count": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Clear Notification
Path Parameters
notification_id*string
Format
uuidHeader Parameters
authorization?|
X-API-Key?|
Cookie Parameters
vai_token?|
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/notifications/497f6eca-6276-4993-bfeb-53cbbbba6f08/clear"{
"cleared": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Mark Notification Read
Path Parameters
notification_id*string
Format
uuidHeader Parameters
authorization?|
X-API-Key?|
Cookie Parameters
vai_token?|
Response Body
application/json
application/json
curl -X POST "https://loading/api/v1/notifications/497f6eca-6276-4993-bfeb-53cbbbba6f08/read"{
"marked": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}