Skip to main content

Users Management - Current User Read

Endpoint

/o/users/me

Overview

Returns the currently authenticated dashboard user object.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

  • Any authenticated dashboard user.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API key.
auth_tokenStringYes (or use api_key)Dashboard auth token.

Examples

Example 1: Read current user

/o/users/me?api_key=YOUR_API_KEY

Response

Success Response

{
"_id": "67b3055b87d9f49e2f5f3201",
"full_name": "Global Admin",
"username": "admin",
"email": "admin@example.com",
"global_admin": true,
"permission": {
"c": {},
"r": {},
"u": {},
"d": {},
"_": {
"a": [],
"u": []
}
},
"api_key": "current_user_api_key"
}

Response Fields

FieldTypeDescription
_idStringCurrent dashboard user id.
full_nameStringFull name.
usernameStringUsername.
emailStringEmail address.
global_adminBooleanGlobal admin flag.
permissionObjectPermission object.
api_keyStringAPI key value in user object.
passwordNot returnedPassword is removed before response.

Error Responses

Authentication and authorization failures are returned by the common auth layer.

Behavior

Behavior Modes

ModeTriggerResponse Shape
Current user responseAuthenticated requestRaw member object without password.

Limitations

  • Response may include additional member fields injected by installed modules.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersAuthentication source data.Read during auth; handler returns authenticated member from request context.