notifications

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-notifications"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/00631a49-d84e-41cc-965a-a44d0da2b153/social-card.svg?v=3e7ae33eec8b" alt="notifications" width="600" height="315"></a>
GEThttps://hermetica.15.204.158.166.sslip.io/v1/notifications

Your in-app notifications in this workspace, newest first, with the unread count

Parameters

limitintegerquery
= 20
cursorstringquery
unreadstringquery
true | false

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/notifications"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "source": "string",
      "title": "string",
      "body": "string",
      "link": "string",
      "data": {},
      "readAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string",
  "unread": 0
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
sourcestringrequired
titlestringrequired
bodystringrequired
linkstringrequired
dataobjectrequired
readAtstringrequired
createdAtstringrequired
nextCursorstringrequired
unreadintegerrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/notifications

POSThttps://hermetica.15.204.158.166.sslip.io/v1/notifications/read

Request body

application/json
idsstring[]required
{
  "ids": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/notifications/read" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/notifications

5XX Default Response

Same as 4XX · GET /v1/notifications

POSThttps://hermetica.15.204.158.166.sslip.io/v1/notifications/read-all

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/notifications/read-all"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "marked": 0
}
Schema
markedintegerrequired
4XX Default Response

Same as 4XX · GET /v1/notifications

5XX Default Response

Same as 4XX · GET /v1/notifications

Updated