Skip to content

Announcements API

Announcements are platform notices we publish: maintenance windows, new features, the occasional heads-up. You can read them and mark them read. That is the whole API - you do not create them.

Every request needs a bearer token.

List announcements

http
GET /api/announcements
json
{
  "data": [
    {
      "id": "...",
      "title": "Scheduled maintenance this weekend",
      "body": "Networking in one region will blip for a few minutes...",
      "level": "warning",
      "read": false,
      "createdAt": "2026-07-15T10:00:00Z"
    }
  ],
  "unreadCount": 1
}

level is info, warning, or critical. read is per-user, so marking one read only affects you, not your teammates.

Mark one read

http
POST /api/announcements/read
json
{ "id": "..." }

Returns 204 No Content.

Mark all read

http
POST /api/announcements/read-all

Clears your unread count in one shot. Returns 204 No Content.

Built for the long tail.