> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Profile Information

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

## OpenAPI

````json GET /api/v1/me
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Authentication"
  },
  "servers": [
    {
      "url": "https://apiexplorer.support.rocket.chat"
    }
  ],
  "tags": [
    {
      "name": "Authentication"
    },
    {
      "name": "Two-Factor Authentication"
    }
  ],
  "paths": {
    "/api/v1/me": {
      "get": {
        "tags": [
          "Authentication"
        ],
        "summary": "Get Profile Information",
        "description": "Quick information about the authenticated user.\n### Changelog\n | Version      | Description | \n | ---------------- | ------------|\n |1.0.0            | Added `avatarUrl` property to response       |\n |0.68.0            | Added `customFields` property.      |\n |0.48.0            | Added      |",
        "operationId": "get-api-v1-me",
        "parameters": [
          {
            "name": "X-User-Id",
            "in": "header",
            "description": "The user ID of the user.",
            "required": "true",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Auth-Token",
            "in": "header",
            "description": "The authorization token of the user.",
            "required": "true",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK \n\nThe `customFields` parameter won't be returned if it doesn't exist on the workspace.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "_id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "emails": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "address": {
                            "type": "string"
                          },
                          "verified": {
                            "type": "boolean"
                          }
                        }
                      }
                    },
                    "status": {
                      "type": "string"
                    },
                    "statusConnection": {
                      "type": "string"
                    },
                    "username": {
                      "type": "string"
                    },
                    "utcOffset": {
                      "type": "integer"
                    },
                    "active": {
                      "type": "boolean"
                    },
                    "roles": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "settings": {
                      "type": "object",
                      "properties": {
                        "preferences": {
                          "type": "object",
                          "properties": {
                            "enableAutoAway": {
                              "type": "boolean"
                            },
                            "idleTimeoutLimit": {
                              "type": "integer"
                            },
                            "desktopNotificationDuration": {
                              "type": "integer"
                            },
                            "audioNotifications": {
                              "type": "string"
                            },
                            "desktopNotifications": {
                              "type": "string"
                            },
                            "mobileNotifications": {
                              "type": "string"
                            },
                            "unreadAlert": {
                              "type": "boolean"
                            },
                            "useEmojis": {
                              "type": "boolean"
                            },
                            "convertAsciiEmoji": {
                              "type": "boolean"
                            },
                            "autoImageLoad": {
                              "type": "boolean"
                            },
                            "saveMobileBandwidth": {
                              "type": "boolean"
                            },
                            "collapseMediaByDefault": {
                              "type": "boolean"
                            },
                            "hideUsernames": {
                              "type": "boolean"
                            },
                            "hideRoles": {
                              "type": "boolean"
                            },
                            "hideFlexTab": {
                              "type": "boolean"
                            },
                            "hideAvatars": {
                              "type": "boolean"
                            },
                            "roomsListExhibitionMode": {
                              "type": "string"
                            },
                            "sidebarViewMode": {
                              "type": "string"
                            },
                            "sidebarHideAvatar": {
                              "type": "boolean"
                            },
                            "sidebarShowUnread": {
                              "type": "boolean"
                            },
                            "sidebarShowFavorites": {
                              "type": "boolean"
                            },
                            "sendOnEnter": {
                              "type": "string"
                            },
                            "messageViewMode": {
                              "type": "integer"
                            },
                            "emailNotificationMode": {
                              "type": "string"
                            },
                            "roomCounterSidebar": {
                              "type": "boolean"
                            },
                            "newRoomNotification": {
                              "type": "string"
                            },
                            "newMessageNotification": {
                              "type": "string"
                            },
                            "muteFocusedConversations": {
                              "type": "boolean"
                            },
                            "notificationsSoundVolume": {
                              "type": "integer"
                            }
                          }
                        }
                      }
                    },
                    "customFields": {
                      "type": "object",
                      "properties": {
                        "twitter": {
                          "type": "string"
                        }
                      }
                    },
                    "avatarUrl": {
                      "type": "string"
                    },
                    "success": {
                      "type": "boolean"
                    }
                  },
                  "x-examples": {
                    "Example 1": {
                      "_id": "aobEdbYhXfu5hkeqG",
                      "name": "Example User",
                      "emails": [
                        {
                          "address": "example@example.com",
                          "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"
                    }
                  }
                },
                "examples": {
                  "User profile": {
                    "value": {
                      "_id": "aobEdbYhXfu5hkeqG",
                      "name": "Example User",
                      "emails": [
                        {
                          "address": "example@example.com",
                          "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"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
````