List Users
List the users in a specific Zoho Mail org.
Options
Field | Definition | Type | Required |
---|---|---|---|
Result Set |
Choose a method to filter search results:
|
Dropdown |
TRUE |
Organization |
Choose the Zoho org to search. You can either choose an org from the dropdown list or select --Enter Org ID-- to enter the org ID manually. |
Dropdown |
TRUE |
Input
Field | Definition | Type | Required |
---|---|---|---|
Organization |
|||
Organization ID |
The ID of your Zoho Mail org. To manually enter a value, select -- Enter Org ID -- in the Organization option. |
Text |
TRUE |
Streaming |
|||
Flow |
Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow. |
Flow |
TRUE |
Record Limit |
Specify the number of records to stream.
This field appears when you select Stream Records from the Result Set option. |
Number |
TRUE |
Output
Field | Definition | Type |
---|---|---|
Result |
||
Users |
List of Objects |
|
User ID |
Unique identifier of the user. |
Text |
First Name |
Given name of the user. |
Text |
Last Name |
Last name of the user. |
Text |
Display Name |
Name that appears in the From header for mail. |
Text |
Gender |
Gender of the user. |
Text |
Address |
Address details for the user. For example, the street address, city, postal code, state, and country. |
Object |
Account Display Name |
The display name shown for the account. |
Text |
Account Name |
Name of the account. |
Text |
Account ID |
The account ID to which the user belongs. |
Text |
Role |
The user's role:
|
Text |
Country |
Country of the user. |
Text |
Last Login |
The date and time of the user's last successful sign-in action. This field also shows new users who have never signed in. |
Date & Time |
MX Status |
True if the mail exchange (MX) record is properly configured to receive email through Zoho Mail servers. |
True/False |
Active Sync Enabled |
True if the Exchange ActiveSync (EAS) feature is enabled for this user. EAS is a proprietary protocol designed to sync emails, calendars, contacts, tasks, and notes between an email server and mobile devices. |
True/False |
Mobile Number |
The user's mobile phone number. |
Text |
Custom Admin |
True if the user is a Custom Admin. |
True/False |
Incoming Blocked |
True if emails to the user's Zoho Mail account are blocked. |
True/False |
Language |
Language setting for the user. |
Text |
Type |
Type of email account. For example, ZOHO_ACCOUNT, Outlook, or Office 365. |
Text |
Extra Storage |
Provides details about the purchase of more storage. |
Object |
Incoming Username |
Full email address for the user's Zoho Mail account. |
Text |
Primary Email Address |
Primary email address associated with the account. |
Text |
Email Address |
The list of email addresses associated with the account. You can use these email addresses to sign in to the account and reset the password. |
List of Objects |
Mailbox Address |
The default mailbox address associated with the account. |
Text |
Mailbox Status |
The delivery status for sent emails:
|
Text |
Ediscovery Storage |
Provides details about the Electronically Stored Information (ESI). ESI can be in the form of emails, spreadsheets, text messages, social media interactions, or any other electronic document. This information is open to eDiscovery when associated with a lawsuit. |
Object |
Extra Ediscovery Storage |
This field provides details about the eDiscovery plan associated with the user's account. You can create investigations and search for specific email information based on your requirements. You can store emails retained under the default and custom retention policies of eDiscovery. This account storage is based on the plan allocated for the user. |
Object |
POP Blocked |
True if the Post Office Protocol (POP) access is blocked for this account. |
True/False |
Used Storage |
The amount of memory used by the user account. |
Number |
Spam Check Enabled |
True if filters are enabled to automatically scan incoming emails for spam. You can enable the spam check by default in Zoho Mail. |
True/False |
IMAP Access Enabled |
True if Internet Message Access Protocol (IMAP) access is enabled for the account. |
True/False |
IMAP Blocked |
True if IMAP access for the account is blocked. |
True/False |
Time Zone |
Time zone setting for the mailbox. This configuration change is global across all Zoho apps. |
Text |
Account Creation Time |
The date and time when the account was created. |
Date & Time |
Web Blocked |
True if web access to the user's email account is blocked. |
True/False |
Plan Storage |
The active storage plan for the user:
|
Number |
Sequence |
The sequence order for the mail accounts associated with the account. |
Number |
Last Password Reset |
The date and time when the password was last reset. |
Date & Time |
TFA Enabled |
True if two factor authentication (TFA) is enabled for the user. |
True/False |
IAM User Role |
Role of the user in the Zoho Mail Identity and Access Management (IAM) system. |
Text |
IAM Status |
Indicates if the IAM system is enabled in Zoho Mail. Zoho Vault is an IAM solution that offers password management and single sign-on (SSO). |
Number |
Phone Number |
User's phone number. |
Text |
Status |
True if the user account is active. |
True/False |
Enabled |
True if the user account is enabled. |
True/False |
Logo Exists |
True if the Zoho Mail logo exists in the mail account. |
True/False |
Mailbox Creation Time |
The date and time when the mailbox was created. |
Date & Time |
Basic Storage |
The subscribed storage plan for the user. |
Text |
Allowed Storage |
The allowed storage limit for the Zoho Mail account. The value is in KB. |
Number |
Last Client |
The last client used to access Zoho Mail. |
Text |
Send Mail Details |
This object identifies specific email data for the user. |
List of Objects |
POP Fetch Time |
The fetch frequency setting used by POP to check the account. |
Number |
POP Access Enabled |
True if the POP feature is enabled in the mailbox settings for this account. |
True/False |
Plan Type |
The type of the Zoho Mail account, based on the subscription plan. |
Number |
User Expiry |
The time period before the account expires. |
Number |
Outgoing Blocked |
True if outgoing email is blocked in the mail settings. |
True/False |
SMTP Status |
True if the Simple Mail Transfer Protocol (SMTP) is enabled for the mail account. To enable SMTP, click SMTP Configuration under Notification Settings and click Add Server. In the dialog that appears, enter the Server Name address for your host's SMTP server. Select the SMTP Port. |
True/False |
Policy ID |
The policy applied to the account and the org ID that the user account is associated with. The Email Policy section under Mail Settings in the Zoho Mail Admin Console allows an admin to manage the org's email transmission parameters. |
Object |
Custom Fields |
Any Custom Field options for the account. |
List of Objects |
Records Streamed |
Number of records streamed in a streaming flow. This field appears when you select Stream Records from the Result Set option. |
Number |