Get User Details
This API allows you to get the details of a particular user. You need to pass the email address of the user in the request URL for whom you want to fetch the details.
Request Type
- GET
Request URL
https://campaigns.zoho.com/emailapi/v2/settings/users/{email_id}
Content-Type
application/json
List of Response Body Attributes
| Parameters | Data Type | Description |
| response | JSON Object | Contains the response details of the API. |
| code | Integer | Success or failure code. |
| message | String | Success or failure message returned by the API. |
| user_details | JSON Object | Contains the details of the user. |
| email_id | String | Email address of the user. |
| is_admin | Boolean | Indicates whether this user is an admin or not. |
| user_status | String | Status of the user. It can be 'active' or 'inactive'. |
| country | String | Country of the user. |
| locale_info | String | Indicates the language- or country-based preferences. |
| user_zuid | Long | User ID of the Zoho Account's user from whose account this API was called. |
| is_confirmed | Boolean | Indicates whether the user has completed the account confirmation. |
| name | String | Name of the user. |
| language | String | Language of the user's account. |
| is_current_user | Boolean | Indicates if this user is the one that made the current API request. |
| time_zone | String | Time zone of the user's account. |
| user_photo | String | Profile photo of the user. |
| errors | JSON Object | Contains the error details of the API such as 'code' and 'message'. |
Possible Errors
| Error Code | Description |
| 400602 | No such user present. |
Sample Response - Success
Copied{
"user_details": {
"email_id": "joanna@zylker.com",
"is_admin": false,
"user_status": "active",
"country": "us",
"locale_info": "en_US",
"user_zuid": 16305813,
"is_confirmed": true,
"name": "Joanna",
"language": "en",
"is_current_user": false,
"time_zone": "Asia/Kolkata",
"user_photo": "//contacts.zoho.com/file?fs=thumb&t=user&height=70&width=70&ID=16305813"
},
"response": {
"code": 200603,
"message": "Successfully obtained the user details"
}
}Sample Response - Failure
Copied{
"errors": [
{
"code": 500601,
"message": "An error occurred in User Management"
}
]
}
