Get Users List

This API allows you to get the list of all the users – along with their details – present in your account irrespective of their status.

Request Type

Request URL

https://campaigns.zoho.com/emailapi/v2/settings/users

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.
users	JSON Array	Contains the list of users and their details.
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
400601	No users found.

Run in Postman View Collection

Sample Response - Success

Copied{
  "response": {
    "code": 200601,
    "message": "Successfully obtained the list of portal users"
  },
  "users": [
    {
      "email_id": "patricia@zylker.com",
      "is_admin": true,
      "user_status": "active",
      "country": "in",
      "locale_info": "en_IN",
      "user_zuid": 16304095,
      "is_confirmed": true,
      "name": "Patricia",
      "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"
    },
    {
      "email_id": "jamal@zylker.com",
      "is_admin": false,
      "user_status": "active",
      "country": "in",
      "locale_info": "en_IN",
      "user_zuid": 16305370,
      "is_confirmed": true,
      "name": "Jamal",
      "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=16305370"
    },
    {
      "email_id": "julius@zylke.com",
      "is_admin": false,
      "user_status": "inactive",
      "country": "us",
      "locale_info": "en_US",
      "user_zuid": 16306501,
      "is_confirmed": true,
      "name": "Julius",
      "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=16306501"
    }
  ]
}

Sample Response - Failure

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