Get Current User's Details

This API allows you to get the details of the current user. Current user is the one who initiates the API call.

Request Type

  • GET

Request URL

https://campaigns.zoho.com/emailapi/v2/settings/users/current-user

Content-Type

application/json

List of Response Body Attributes

ParametersData TypeDescription
responseJSON ObjectContains the response details of the API.
codeIntegerSuccess or failure code.
messageStringSuccess or failure message returned by the API.
usersJSON ArrayContains the list of users and their details.
email_idStringEmail address of the user.
is_adminBooleanIndicates whether this user is an admin or not.
user_statusStringStatus of the user. It can be 'active' or 'inactive'.
countryStringCountry of the user.
locale_infoStringIndicates the language- or country-based preferences.
user_zuidLongUser ID of the Zoho Account's user from whose account this API was called.
is_confirmedBooleanIndicates whether the user has completed the account confirmation.
nameStringName of the user.
languageStringLanguage of the user's account.
is_current_userBooleanIndicates if this user is the one that made the current API request.
time_zoneStringTime zone of the user's account.
user_photoStringProfile photo of the user.
errorsJSON ObjectContains the error details of the API such as 'code' and 'message'.

 

Sample Response - Success

Copied{
  "response": {
    "code": 200602,
    "message": "Successfully obtained the current user"
  },
  "current_user": {
    "email_id": "aleksandr@zylker.com",
    "is_admin": true,
    "user_status": "active",
    "country": "in",
    "locale_info": "en_IN",
    "user_zuid": 16304095,
    "is_confirmed": true,
    "name": "Aleksandr",
    "language": "en",
    "is_current_user": true,
    "time_zone": "Asia/Kolkata",
    "user_photo": "//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=16304095"
  }
}

Sample Response - Failure

Copied{
  "errors": [
    {
      "code": 500601,
      "message": "An error occurred in User Management"
    }
  ]
}