EventPage
A page of the events that the user sees and that have not ended, the nearest start first.
object
An opaque pagination cursor. Clients pass it back unchanged and never parse it.
An event of the local users of this server, as the user sees it. Times are in UTC;
time_zone is the event’s own time zone, to show next to the user’s. places holds only the
places that the user sees: hidden_places lists the kinds of the others, whose details never
reach the client.
object
The ID of a resource, a UUIDv7 in its canonical string form.
Schema: Account
object
The co-organizers, in the order the organizer named them; up to 3.
An account, as clients show it.
object
The ID of a resource, a UUIDv7 in its canonical string form.
The username, without the domain; empty for a remote account without a confirmed handle.
The username for local accounts, username@domain for remote ones; empty for a remote
account without a confirmed handle.
The domain of the account: the domain of its handle, which for local accounts is the
instance’s account domain, or the host of its uri when a remote account has no
confirmed handle.
The ActivityPub id of the account’s actor, on the server it belongs to.
The display name; empty when the account has none.
The profile text as sanitized HTML; empty when there is none.
The account’s profile page: on this instance for a local account, and for a remote
one the page its actor declares (url), or its uri when it declares none.
Whether follow requests need the account’s approval.
Whether the account is automated.
When the account was created.
The profile’s metadata fields, in their order; empty when there are none.
One metadata field of a profile.
object
The field’s name, as plain text.
The field’s value as sanitized HTML.
The custom emoji of the display name, the note, and the fields’ names and values. Clients show each :shortcode: of those texts that is in this list as its
image, and the rest as text.
A custom emoji that a text uses. The text has it as :shortcode:.
An emoji that is disabled or deleted, or whose images come from a domain whose media the
instance rejects, is not listed, and its :shortcode: stays text. Clients show
static_url when animations should not play (prefers-reduced-motion), and url
otherwise.
object
The shortcode, without the colons around it.
The URL of the image, animated when the emoji is.
The URL of a still image of the emoji; the same as url when no still version is served.
The role badges that the account shows on its profile, highest role first.
Filled on the account’s own endpoints (getAccount, lookupAccount,
verifyAccountCredentials) only, and empty where accounts are listed or embedded (posts,
notifications, lists of accounts) and for remote accounts. Badges are never federated.
A badge that the account shows on its profile: the badge of a role that the
account’s user holds and chose to show. Clients show label as user content (dir="auto"),
never translated.
object
The ID of a resource, a UUIDv7 in its canonical string form.
The name on the badge.
The color of a role badge: the name of a pair of the web client’s design tokens
for its background and its text, which keep their contrast in the light and the dark theme.
Server themes do not change them. The color is decoration; the badge’s label carries its
meaning.
The avatar image, square; omitted when the account has none, or its image is not processed yet or could not be processed. Clients show a placeholder instead. For a remote account, every size is its media proxy URL.
Schema: MediaVariants
object
The header image; omitted when there is none, as avatar is.
Schema: MediaVariants
object
The number of accounts that actively follow the account, as far as the instance
knows. Present on the account’s own endpoints (getAccount, lookupAccount,
verifyAccountCredentials) and left out where accounts are listed or embedded.
The number of accounts that the account actively follows; present where followers_count is.
The account that the account moved to, when it moved: clients show that it
moved, with a link to this one. Present on the account’s own endpoints, where
followers_count is, and without a moved of its own (moves are not followed in
chains).
Schema: Account
object
The open voice chat room where the account is the host or a speaker, when the user sees
it. Present only on GET /accounts/{id}.
Schema: VoiceRoomEntry
object
Plain text; empty for none.
Who sees an event: public every local user, followers the users who follow the organizer,
following the users the organizer follows, mutuals the users who follow the organizer and
whom the organizer follows, and invited the invited users only. The organizer, the
co-organizers, the invited users, and the users who answered always see it, unless a block
separates them from the organizer or a co-organizer.
The IANA name of the event’s time zone, such as Asia/Tokyo.
Who sees the physical and url places of an event: approved only the attendees whom the
organizer or a co-organizer approved, and viewers everyone who sees the event. The organizer
and the co-organizers see them always, and a voice place is shown to everyone who sees the
event.
How many attendees may answer going; 0 for no limit.
Who posts on the board of an event, among those who read it: organizer the organizer alone,
organizers the organizer and the co-organizers, and readers everyone who reads the board.
The board is read by the organizer, the co-organizers, and the users who see the event and
answer going or maybe.
A place of an event. A physical place has a name, an address, and an optional map link in
url; a url place has a name and a url; a voice place has speakers, who may speak
without asking in the voice chat room that opens when the event starts. A URL is an http or
https URL of up to 2,000 characters, which the server never fetches. The fields that a kind
does not have are omitted.
object
The kind of a place: voice a voice chat room of this server, physical a place to meet in
person, and url a link such as a stream or a meeting of another service.
Up to 100 characters on one line.
Up to 500 characters; line breaks are kept.
Who may speak without asking in the room; manual when omitted.
For a voice place, the voice chat room that the start of the event’s current date
opened (GET /voice/rooms/{id}), which may have ended since; omitted before the room opens.
Ignored in a request.
For a voice place, why the room of the event’s current date could not open at the
start; omitted otherwise. Ignored in a request.
The kinds of the places that the user does not see.
The start of the event; for an unscheduled event, the earliest start of its candidate
dates (GET /events/{id}/candidates).
The end of the event; for an unscheduled event, the latest end of its candidate dates.
Whether an event is unscheduled (it polls its date and no candidate was confirmed yet),
scheduled, or cancelled. An event that ended is still scheduled: its ends_at is in the
past.
Schema: EventCancellation
object
How many attendees answer going.
When the settings were last changed (the creation for an event never changed).
How many versions the settings have had, the first included.
Schema: EventViewer
object
Example generated
{ "next_cursor": "example", "items": [ { "id": "01890a5d-ac96-774b-bcce-b302099a8057", "organizer": {}, "coorganizers": [ { "id": "01890a5d-ac96-774b-bcce-b302099a8057", "username": "example", "acct": "example", "domain": "example", "uri": "https://example.com", "display_name": "example", "note": "example", "url": "https://example.com", "locked": true, "bot": true, "created_at": "2026-04-15T12:00:00Z", "fields": [ { "name": "example", "value": "example" } ], "emojis": [ { "shortcode": "example", "url": "https://example.com", "static_url": "https://example.com" } ], "badges": [ { "role_id": "01890a5d-ac96-774b-bcce-b302099a8057", "label": "example", "color": "neutral" } ], "avatar": {}, "header": {}, "followers_count": 1, "following_count": 1, "moved": {}, "voice_room": {} } ], "title": "example", "description": "example", "visibility": "public", "time_zone": "example", "place_disclosure": "approved", "capacity": 1, "board_writers": "organizer", "places": [ { "kind": "voice", "name": "example", "address": "example", "url": "example", "speakers": "everyone" } ], "hidden_places": [ "voice" ], "starts_at": "2026-04-15T12:00:00Z", "ends_at": "2026-04-15T12:00:00Z", "state": "unscheduled", "cancellation": {}, "going_count": 1, "created_at": "2026-04-15T12:00:00Z", "revised_at": "2026-04-15T12:00:00Z", "revision_count": 1, "viewer": {} } ]}For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt