Skip to main content
GET
/
v1
/
api
/
notifications
List notifications
curl --request GET \
  --url https://api.hq.zone/v1/api/notifications \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "<string>",
      "severity": "<string>",
      "status": "<string>",
      "title": "<string>",
      "body": "<string>",
      "cta": "<unknown>"
    }
  ],
  "unread": 123
}

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Response

200 - application/json

Notifications for the caller

items
object[]
required
unread
integer<int64>
required

How many of the returned-scope rows are still unread - drives the bell badge in the SPA.