Public profile for a user (by RS ref)

GET

/users/{ref}

• Local development behind nginx (port 8088 by default)

Returns the merged user + user_profile view used to render author headers in the post modal, the /@username profile page, and federation actor representations. Profile-less users render fine with substituted defaults.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

ref

required

integer format: int64

Responses

200

Public profile

Merged user + profile view. display_name is the resolved display string (profile.display_name → user.fullname → user.username, first non-empty). avatar_url is null for users without an uploaded avatar; the frontend renders a generated initials disc in that case.

object

ref

required

integer format: int64

username

required

string

fullname

The raw user.fullname value, for the rare case a caller needs the unresolved string (account settings page). Most UI surfaces should use display_name instead.

string

nullable

display_name

required

Resolved display string ready to render — never empty.

string

bio

string

avatar_url

string

nullable

location

string

website_url

string format: uri

nullable

social_links

Free-form platform → handle map. Frontend renders known platforms (twitter, instagram, artstation, …) as icon links; unknown keys are ignored.

object

key

additional properties

string

language

IETF BCP47 language tag (e.g. “en”, “es-AR”). Empty string = “use system / browser default”. Drives the i18n switcher in the user menu.

string

theme

UI theme preference. Empty string = follow system / OS. Persisted alongside the profile so it follows the user across browsers.

string

Allowed values: "" light dark

member_since

required

string format: date-time

post_count

required

Total live posts authored by this user.

integer format: int64

origin_server_id

Set on profiles mirroring a remote site’s user. NULL = locally-owned account.

string format: uuid

nullable

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

404

Resource not found

object

error

required

Human-readable error summary

string

Example

the request could not be completed