Skip to content

AnnouncementPage

A page of announcements.

object
next_cursor

An opaque pagination cursor. Clients pass it back unchanged and never parse it.

string
>= 1 characters <= 256 characters
items
required
Array<object>

An announcement of the server to every local user, as the user sees it.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
title
required

The heading, in plain text, as the administrators wrote it; render it with dir="auto". Empty for an announcement without one.

string
content
required

The text as an HTML fragment, sanitized (paragraphs, emphasis, lists, quotes, code, headings from h2, and http, https, and mailto links).

string
published_at
required

When it started to show to the users, its publication or the start of its window.

string format: date-time
ends_at

When it stops showing; omitted when it shows until it is withdrawn.

string format: date-time
revised_at
required

When its text or window last changed.

string format: date-time
read
required

Whether the user has marked it read.

boolean
ended
required

Whether its window has ended, which only the list with the past announcements (listAnnouncementHistory) has; such an announcement can no longer be marked read.

boolean

Example generated

{
"next_cursor": "example",
"items": [
{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"title": "example",
"content": "example",
"published_at": "2026-04-15T12:00:00Z",
"ends_at": "2026-04-15T12:00:00Z",
"revised_at": "2026-04-15T12:00:00Z",
"read": true,
"ended": true
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site