Get Profile Information

Prev Next
Get
/api/v1/me

Quick information about the authenticated user.

Changelog

Version Description
1.0.0 Added avatarUrl property to response
0.68.0 Added customFields property.
0.48.0 Added
Header parameters
X-User-Id
stringRequired

The user ID of the user.

X-Auth-Token
stringRequired

The authorization token of the user.

Responses
200

OK

The customFields parameter won't be returned if it doesn't exist on the workspace.

User profile
{
  "_id": "aobEdbYhXfu5hkeqG",
  "name": "Example User",
  "emails": [
    {
      "address": "[email protected]",
      "verified": true
    }
  ],
  "status": "offline",
  "statusConnection": "offline",
  "username": "example",
  "utcOffset": 0,
  "active": true,
  "roles": [
    "user",
    "admin"
  ],
  "settings": {
    "preferences": {
      "enableAutoAway": false,
      "idleTimeoutLimit": 300,
      "desktopNotificationDuration": 0,
      "audioNotifications": "mentions",
      "desktopNotifications": "mentions",
      "mobileNotifications": "mentions",
      "unreadAlert": true,
      "useEmojis": true,
      "convertAsciiEmoji": true,
      "autoImageLoad": true,
      "saveMobileBandwidth": true,
      "collapseMediaByDefault": false,
      "hideUsernames": false,
      "hideRoles": false,
      "hideFlexTab": false,
      "hideAvatars": false,
      "roomsListExhibitionMode": "category",
      "sidebarViewMode": "medium",
      "sidebarHideAvatar": false,
      "sidebarShowUnread": false,
      "sidebarShowFavorites": true,
      "sendOnEnter": "normal",
      "messageViewMode": 0,
      "emailNotificationMode": "all",
      "roomCounterSidebar": false,
      "newRoomNotification": "door",
      "newMessageNotification": "chime",
      "muteFocusedConversations": true,
      "notificationsSoundVolume": 100
    }
  },
  "customFields": {
    "twitter": "@userstwi"
  },
  "avatarUrl": "http://localhost:3000/avatar/test",
  "success": true
}
Expand All
object
_id
string
name
string
emails
Array of object
object
address
string
verified
boolean
status
string
statusConnection
string
username
string
utcOffset
integer
active
boolean
roles
Array of string
string
settings
object
preferences
object
enableAutoAway
boolean
idleTimeoutLimit
integer
desktopNotificationDuration
integer
audioNotifications
string
desktopNotifications
string
mobileNotifications
string
unreadAlert
boolean
useEmojis
boolean
convertAsciiEmoji
boolean
autoImageLoad
boolean
saveMobileBandwidth
boolean
collapseMediaByDefault
boolean
hideUsernames
boolean
hideRoles
boolean
hideFlexTab
boolean
hideAvatars
boolean
roomsListExhibitionMode
string
sidebarViewMode
string
sidebarHideAvatar
boolean
sidebarShowUnread
boolean
sidebarShowFavorites
boolean
sendOnEnter
string
messageViewMode
integer
emailNotificationMode
string
roomCounterSidebar
boolean
newRoomNotification
string
newMessageNotification
string
muteFocusedConversations
boolean
notificationsSoundVolume
integer
customFields
object
twitter
string
avatarUrl
string
success
boolean