Users
Returns user accounts along with email, role, profile, and active status.
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 identifier (Id) for the user. |
| FirstName | String | The user's first name. |
| LastName | String | The user's last name. |
| FullName | String | The user's full name. |
| String | The user's email address. | |
| RoleName | String | The name of the role assigned to the user. |
| RoleId | String | The Id of the role assigned to the user. |
| ProfileName | String | The name of the profile assigned to the user. |
| ProfileId | String | The Id 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 where the user is located. |
| State | String | The state where the user is located. |
| Zip | String | The postal code where the user is located. |
| Alias | String | The user's alias. |
| Signature | String | The user's email signature. |
| NameFormat | String | The format used for displaying the user's name. |
| PersonalAccount | Boolean | Indicates whether the user has a personal account. |
| DefaultTabGroup | String | The user's default tab group setting. |
| CountryLocale | String | The user's default country locale. |
| Fax | String | The user's fax number. |
| Website | String | The user's website. |
| 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 current status of the user. |
| Confirm | Boolean | Indicates whether the user's email address has been confirmed. |
| Language | String | The user's preferred language. |
| Locale | String | The user's locale setting. |
| TimeFormat | String | The user's preferred time format. |
| DateFormat | String | The user's preferred date format. |
| DecimalSeparator | String | The character used as the decimal separator in the user's locale. |
| TimeZone | String | The user's configured time zone. |
| Zuid | String | The user's Zoho User ID (ZUID). |
| Territories | String | A comma-separated list of territories assigned to the user. |
| CreatedByName | String | The name of the user who created this user account. |
| CreatedById | String | The Id of the user who created this user account. |
| CreatedAt | Datetime | The date and time when this user account was created. |
| ModifiedByName | String | The name of the user who last modified this user account. |
| ModifiedById | String | The Id of the user who last modified this user account. |
| ModifiedAt | Datetime | The date and time when this user account was last modified. |
| CustomizeInfoNotesDesc | String | Information related to customized notes. |
| CustomizeInfoShowRightPanel | Boolean | Indicates whether the right panel is shown for this user. |
| CustomizeInfoShowLeftPanel | Boolean | Indicates whether the left panel is shown for this user. |
| CustomizeInfoBcView | String | The breadcrumb view setting for the user. |
| CustomizeInfoShowHome | Boolean | Indicates whether the home tab is shown for this user. |
| CustomizeInfoShowDetailView | Boolean | Indicates whether the detail view is enabled for this user. |
| CustomizeInfoUnpinRecentItem | String | The setting for unpinning recent items. |
| Microsoft | Boolean | Indicates whether the user is linked to a Microsoft account. |
| ThemeBackground | String | The background setting for the user's theme. |
| ThemeNewBackground | String | The updated background setting for the user's theme. |
| ThemeNormalTabBackground | String | The background color for normal tabs. |
| ThemeNormalTabFontColor | String | The font color used for normal tabs. |
| ThemeScreen | String | The screen setting for the theme. |
| ThemeSelectedTabBackground | String | The background color for selected tabs. |
| ThemeSelectedTabFontColor | String | Represents the font color used for the selected tab in the user's chosen theme. |
| ThemeType | String | The type of theme applied to the user's interface. |
| ReportingToName | String | The name of the user this user reports to. |
| ReportingToId | String | The Id of the user this user reports to. |
| Offset | Integer | The pagination offset used when retrieving user records. |
| SandboxDeveloper | Boolean | Indicates whether the user is a sandbox developer. |
| Category | String | The category of the user account. |
| SortOrderPreference | String | The user's sort order preference for lists. |
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 | Restricts the returned users to those matching the specified type.
The allowed values are AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser. |