DeluxHostAPI Reference
Notifications

List notifications

GET
/v1/notifications

One ordered stream of the things that already reach the dashboard bell: a service provisioned or suspended, an invoice raised, a charge that failed. This is what to poll instead of diffing /v1/services and /v1/invoices against your own copy.

Two cursors, and they walk opposite ways:

  • before — page back through history, newest first.
  • after — everything since id N, oldest first. That ordering is the point: newest-first, a client that missed more than limit rows would advance its cursor past what it never read.

nextCursor is always passed back in the same parameter you used. Rows can be deleted (the dashboard bell dismisses them), so ids in the feed can have gaps.

Read-only: nothing here marks a notification read — read is the dashboard's state.

Authorization

apiToken account:read
headerAuthorizationBearer <token>

A personal API token: Authorization: Bearer dh_live_…. See Authentication for scopes.

Scope: account:read

Query Parameters

limit?integer
Range1 <= value <= 100
Default25
before?integer

Rows older than this id, newest first.

after?integer

Rows newer than this id, oldest first. The polling cursor.

Response Body

One page of the feed, plus the unread count.

application/json
  1. response
items*array<>
nextCursor*integer|null
unread*integer

Unread in the dashboard, across the whole account — not just this page.

curl -X GET 'https://api.deluxhost.net/v1/notifications' \  -H "Authorization: Bearer $DELUXHOST_TOKEN"
Example Response
{  "items": [    {      "id": 0,      "type": "ticket",      "title": "string",      "body": "string",      "dashboardPath": "string",      "read": true,      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": 0,  "unread": 0}