Users
Returns user accounts along with email, role, profile, active status, and last login time.
View-Specific Information
Select
The cmdlet will use the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the cmdlet.
- Id supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM Users WHERE Id = '3152079000000150015'
Columns
| Name | Type | Description |
| Id [KEY] | String | A unique numeric identifier for the user. |
| FirstName | String | The first name of the user. |
| LastName | String | The last name of the user. |
| FullName | String | The full name of the user. |
| String | The email address of the user. | |
| RoleName | String | The name of the role assigned to the user. |
| RoleId | String | The unique identifier of the role assigned to the user. |
| ProfileName | String | The name of the profile assigned to the user. |
| ProfileId | String | The unique identifier of the profile assigned to the user. |
| Country | String | The country where the user is located. |
| City | String | The city where the user is located. |
| Street | String | The street address of the user. |
| State | String | The state where the user is located. |
| Zip | String | The ZIP or postal code where the user is located. |
| Alias | String | The alias assigned to the user. |
| Signature | String | The email signature used by the user. |
| NameFormat | String | The display format for the user's name. |
| PersonalAccount | Boolean | Indicates whether the user has a personal account. |
| DefaultTabGroup | String | The default tab group assigned to the user. |
| CountryLocale | String | The default country locale of the user. |
| Fax | String | The fax number of the user. |
| Website | String | The website URL associated with the user. |
| Mobile | String | The user's mobile phone number. |
| Phone | String | The user's landline phone number. |
| Dob | String | The user's date of birth. |
| Status | String | The status of the user's account. |
| Confirm | Boolean | Indicates whether the user has confirmed their email address. |
| Language | String | The preferred language of the user. |
| Locale | String | The locale setting for the user. |
| TimeFormat | String | The preferred time format for the user. |
| DateFormat | String | The preferred date format for the user. |
| DecimalSeparator | String | The decimal separator setting for the user. |
| TimeZone | String | The time zone assigned to the user. |
| Zuid | String | The Zoho User ID (ZUID) assigned to the user. |
| CreatedByName | String | The name of the user who created this user account. |
| CreatedById | String | The unique identifier of the user who created this user account. |
| CreatedAt | Datetime | The date and time when the user account was created. |
| ModifiedByName | String | The name of the user who last modified this user account. |
| ModifiedById | String | The unique identifier of the user who last modified this user account. |
| ModifiedAt | Datetime | The date and time when the user account was last modified. |
| NumberSeparator | String | The symbol used for separating number values in the user interface. |
| CustomizeInfoNotesDesc | String | Describes the notes section in the customized information area. |
| CustomizeInfoShowRightPanel | Boolean | Indicates whether the right panel is displayed in the customized information view. |
| CustomizeInfoShowLeftPanel | Boolean | Indicates whether the left panel is displayed in the customized information view. |
| CustomizeInfoBcView | String | The view format for business card information in the customized info section. |
| CustomizeInfoShowHome | Boolean | Indicates whether the home tab is shown in the customized information view. |
| CustomizeInfoShowDetailView | Boolean | Indicates whether the detail view is shown in the customized information view. |
| CustomizeInfoUnpinRecentItem | String | The setting used for unpinning the recent item from the customized view. |
| Microsoft | Boolean | Indicates whether the user account is associated with Microsoft. |
| ThemeBackground | String | The background theme selected by the user. |
| ThemeNewBackground | String | The updated background theme selected by the user. |
| ThemeNormalTabBackground | String | The background color of the unselected tab. |
| ThemeNormalTabFontColor | String | The font color of the unselected tab. |
| ThemeScreen | String | The screen theme selected by the user. |
| ThemeSelectedTabBackground | String | The background color of the selected tab. |
| ThemeSelectedTabFontColor | String | Represents the font color used for the selected tab in the user's chosen theme. |
| ThemeType | String | The theme type applied to the user interface. |
| ReportingToName | String | The name of the user that this user reports to. |
| ReportingToId | String | The unique identifier of the user that this user reports to. |
| Offset | Integer | The result offset for paginated queries. |
| SandboxDeveloper | Boolean | Indicates whether the user is a sandbox developer. |
| Category | String | The user category, such as standard or custom. |
| SortOrderPreference | String | Specifies how records are sorted in responses, such as by first name or last name. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Type | String | Limits the returned user list to those of the specified type.
The allowed values are AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser. |