Skip to content

CredentialAccount

The authenticated user’s own account, with what only its owner sees.

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

Whether the account is suggested to others and found by the middle of its names in the account search; when false, the search finds it only by its whole username. New accounts are discoverable.

boolean
indexable
required

Whether the account’s profile and public posts may be indexed for search: by this instance’s search and, when the instance’s search_indexing is allow, by search engines. New accounts take the instance’s default.

boolean
ai_opt_out
required

Whether the account’s pages state that AI may neither train on nor use them, whatever the instance’s ai_usage. The statement is made by the pages of this instance only; other servers and the media files do not carry it.

boolean
feed_enabled
required

Whether the owner lets the Atom feed of the account’s public posts be served at the profile’s url followed by .atom, and its public posts appear in the Atom feeds of hashtags. It is the owner’s own choice once made, and indexable until then (feed_follows_indexable). A restricted or moved account has no feed whatever it says.

boolean
feed_follows_indexable
required

Whether the owner has not chosen about the feed yet, so that feed_enabled follows indexable. Setting feed_enabled makes the choice, and a later change of indexable leaves it as it is.

boolean
follows_visibility
required

Who may read an account’s follows and followers lists (GET /accounts/{id}/following and GET /accounts/{id}/followers): public, everyone; followers, the accounts whose follow of it is approved; private, nobody. The owner always reads both, and the counts (following_count, followers_count) stay visible to everyone. Other servers see the number of follows and followers alone unless the lists are public.

string
Allowed values: public followers private
source
required

Schema: AccountSource

object
posting
required

Schema: PostingLimits

object
statuses_count
required

The number of the account’s own posts that are not deleted, of every visibility. Only the owner sees it; other accounts do not carry it. A client that creates a post adds one to it, so a count of 1 after the create is the account’s first post.

integer format: int64
follow_requests_count
required

The number of follow requests that await the account’s approval. Only the owner sees it. Accepting or rejecting a request takes it out of the count. Like followers_count, it also counts the requests of deactivated accounts, which GET /follow_requests leaves out.

integer format: int64
last_moved_at

When the account last moved to another account, also when that move was canceled; omitted when it never moved.

string format: date-time
can_move_at

From when the account can move again, 30 days after its last move; omitted when it can move now.

string format: date-time
permissions
required

The permissions that the user’s roles grant, which the admin operations need; empty for a user without roles. Clients show the admin screens by them; the server checks the permission of each admin operation regardless.

Array<string>
Allowed values: manage_reports manage_accounts manage_domains manage_rules manage_settings manage_roles manage_invites view_audit manage_jobs manage_login_recovery manage_custom_emojis manage_webhooks manage_announcements manage_finance view_finance manage_supporters create_custom_emojis manage_oauth_apps manage_service_closure start_voice_rooms manage_errors manage_login_providers create_invites keep_posts_longer create_articles create_events

Example generated

{
"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": {},
"discoverable": true,
"indexable": true,
"ai_opt_out": true,
"feed_enabled": true,
"feed_follows_indexable": true,
"follows_visibility": "public",
"source": {},
"posting": {},
"statuses_count": 1,
"follow_requests_count": 1,
"last_moved_at": "2026-04-15T12:00:00Z",
"can_move_at": "2026-04-15T12:00:00Z",
"permissions": [
"manage_reports"
]
}

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

Analytics on this site