User data

Get a profile field for a user.

Get the value of a profile field for a user.

get/_matrix/client/v3/profile/{userId}/{keyName}

Request

Base URL
https://matrix.org
Auth
none declared
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/profile/:userId/:keyName/get.ts
A function with typed inputs. Its response is checked against the schema.

userIdstring mx-user-id required

The user whose profile field should be returned.

keyNamestring required

The name of the profile field to retrieve.

The profile field value was retrieved.

object required

An object with one property, whose key matches the keyName specified in the URL, and whose value is the current setting of that profile field.

No recorded changes to this operation across all 1 revision of this API.