Sign in

v34

OpenAPI 3.0.0raw.githubusercontent.com2025-12-190033.8 KB
User Info

Get user info

get/_twake/v1/user_info/{userId}

Path parameters

userIdstring required

The user‑id used in the request path.

Response

User info found

uidstring required

The fully‑qualified Matrix user identifier (e.g. @johndoe:matrix.org). Always present.

display_namestring required

Human‑readable name for the user. Always present.

avatar_urlstring uri

URL of the user’s avatar (mxc:// URI). Present only if the Matrix server stores an avatar for the user.

phonesstring[]

List of phone numbers associated with the user in the local UserDB. Present only when such associations exist.

emailsstring[]

List of e‑mail addresses associated with the user in the local UserDB. Present only when such associations exist.

snstring

DEPRECATED Surname (family name) from the UserDB. Present only when the UserDB contains this attribute.

last_namestring

Given name (first name) from the UserDB. Present only when the UserDB contains this attribute.

givenNamestring

DEPRECATED Surname (family name) from the UserDB. Present only when the UserDB contains this attribute.

first_namestring

Given name (first name) from the UserDB. Present only when the UserDB contains this attribute.

languagestring

Preferred language code (e.g. en, fr). Present only when common settings are enabled and a value is stored.

timezonestring

IANA time‑zone identifier (e.g. Europe/Paris). Present only when common settings are enabled and a value is stored.

Example response

{
  "uid": "@johndoe:matrix.org",
  "display_name": "John Doe",
  "avatar_url": "mxc://synapse/mediaid",
  "phones": [
    "+1 234 567 8910"
  ],
  "emails": [
    "j.doe@email.com"
  ],
  "sn": "Doe",
  "last_name": "John",
  "givenName": "Doe",
  "first_name": "John",
  "language": "en",
  "timezone": "Europe/Paris"
}