Skip to content

EventPage

A page of the events that the user sees and that have not ended, the nearest start first.

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 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
id
required

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

string format: uuid
organizer
required

Schema: Account

object
coorganizers
required

The co-organizers, in the order the organizer named them; up to 3.

Array<object>

An account, as clients show it.

object
id
required

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

string format: uuid
username
required

The username, without the domain; empty for a remote account without a confirmed handle.

string
acct
required

The username for local accounts, username@domain for remote ones; empty for a remote account without a confirmed handle.

string
domain
required

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.

string
uri
required

The ActivityPub id of the account’s actor, on the server it belongs to.

string format: uri
display_name
required

The display name; empty when the account has none.

string
note
required

The profile text as sanitized HTML; empty when there is none.

string
url
required

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.

string format: uri
locked
required

Whether follow requests need the account’s approval.

boolean
bot
required

Whether the account is automated.

boolean
created_at
required

When the account was created.

string format: date-time
fields
required

The profile’s metadata fields, in their order; empty when there are none.

Array<object>

One metadata field of a profile.

object
name
required

The field’s name, as plain text.

string
value
required

The field’s value as sanitized HTML.

string
emojis
required

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.

Array<object>

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
shortcode
required

The shortcode, without the colons around it.

string
url
required

The URL of the image, animated when the emoji is.

string format: uri
static_url
required

The URL of a still image of the emoji; the same as url when no still version is served.

string format: uri
badges
required

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.

Array<object>

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
role_id
required

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

string format: uuid
label
required

The name on the badge.

string
color
required

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.

string
Allowed values: neutral red orange yellow green teal blue purple pink
avatar

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
header

The header image; omitted when there is none, as avatar is.

Schema: MediaVariants

object
followers_count

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.

integer
following_count

The number of accounts that the account actively follows; present where followers_count is.

integer
moved

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
voice_room

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
title
required
string
description
required

Plain text; empty for none.

string
visibility
required

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.

string
Allowed values: public followers following mutuals invited
time_zone
required

The IANA name of the event’s time zone, such as Asia/Tokyo.

string
place_disclosure
required

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.

string
Allowed values: approved viewers
capacity
required

How many attendees may answer going; 0 for no limit.

integer
board_writers
required

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.

string
Allowed values: organizer organizers readers
places
required
Array<object>

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
kind
required

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.

string
Allowed values: voice physical url
name

Up to 100 characters on one line.

string
address

Up to 500 characters; line breaks are kept.

string
url
string
speakers

Who may speak without asking in the room; manual when omitted.

string
Allowed values: everyone followers following mutuals manual
room_id

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.

string format: uuid
room_unavailable

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.

string
Allowed values: disabled not_eligible too_many_rooms hosting_elsewhere
hidden_places
required

The kinds of the places that the user does not see.

Array<string>
Allowed values: voice physical url
starts_at
required

The start of the event; for an unscheduled event, the earliest start of its candidate dates (GET /events/{id}/candidates).

string format: date-time
ends_at
required

The end of the event; for an unscheduled event, the latest end of its candidate dates.

string format: date-time
state
required

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.

string
Allowed values: unscheduled scheduled cancelled
cancellation
object
going_count
required

How many attendees answer going.

integer
created_at
required
string format: date-time
revised_at
required

When the settings were last changed (the creation for an event never changed).

string format: date-time
revision_count
required

How many versions the settings have had, the first included.

integer
viewer
required

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

Analytics on this site