For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notifications

Get pending notifications for user

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitinteger · max: 50OptionalDefault: 50
offsetinteger · max: 2147483647OptionalDefault: 0
Responses
200

Successful response

application/json
totalnumberRequired
limitnumberRequired
offsetnumberRequired
get/notifications/me
GET /api/v2/notifications/me HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "values": [
    {
      "type": "text",
      "hydrated": null,
      "id": 1,
      "date": "text",
      "data": {
        "title": "text",
        "body": "text"
      }
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get notifications stats for user

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful response

application/json
unreadCountnumberRequired
get/notifications/stats/me
GET /api/v2/notifications/stats/me HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "unreadCount": 1
}

Mark notifications as read for user

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful response

application/json
readnumberRequired
post/notifications/me/mark-as-read
POST /api/v2/notifications/me/mark-as-read HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "read": 1
}

Get notification settings for user

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful response

application/json
get/notifications/me/settings
GET /api/v2/notifications/me/settings HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": {
    "listDisabled": true,
    "pushDisabled": true
  }
}

Update notification settings for user

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful response

application/json
anyOptional
put/notifications/me/settings
PUT /api/v2/notifications/me/settings HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "settings": {
    "ANY_ADDITIONAL_PROPERTY": {
      "listDisabled": true,
      "pushDisabled": true
    }
  }
}

No content

Last updated