Users
Create, update, delete, and query information about users.
Table-Specific Information
Select
The driver 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 driver.
- Id supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM Users WHERE Id = '3152079000000150015'
Insert
INSERT INTO Users(FirstName, LastName, Email, RoleId, ProfileId) VALUES ('Rob','Stark', '[email protected]', '2732548000000026008', '2732548000000026014')
Required fields: FirstName, Email, RoleId, ProfileId.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
Update
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Users SET FirstName = 'Jon' WHERE Id = '2732548000000125009'
Required fields: Id.
Delete
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Users WHERE Id = '2732548000009252002'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique numeric identifier for the user. |
| FirstName | String | False |
The first name of the user. |
| LastName | String | False |
The last name of the user. |
| FullName | String | True |
The full name of the user. |
| String | False |
The email of the user. | |
| RoleName | String | True |
The name of the role the user has. |
| RoleId | String | False |
The Id of the role the user has. |
| ProfileName | String | True |
The name of the profile the user has. |
| ProfileId | String | False |
The Id of the profile the user has. |
| Country | String | False |
The country where the user is situated. |
| City | String | False |
The city where the user is situated. |
| Street | String | False |
The street where the user is situated. |
| State | String | False |
The state where the user is situated. |
| Zip | String | False |
The zip where the user is situated. |
| Alias | String | True |
The alias of the user. |
| Signature | String | False |
The signature of the user. |
| NameFormat | String | False |
The format of the name of the user. |
| PersonalAccount | Boolean | True |
Whether this user has a personal account or not. |
| DefaultTabGroup | String | True |
The default tab group for this user. |
| CountryLocale | String | False |
The default country locale of the user. |
| Fax | String | False |
The fax of the user. |
| Website | String | False |
The website of the user. |
| Mobile | String | False |
The mobile phone number of the user. |
| Phone | String | False |
The phone number of the user. |
| Dob | String | False |
The date of birth of the user. |
| Status | String | True |
The status of the user. |
| Confirm | Boolean | True |
Whether this user has confirmed his email or not. |
| Language | String | False |
The Language of the user. |
| Locale | String | False |
The locale of the user. |
| TimeFormat | String | False |
The default time format of the user. |
| DateFormat | String | False |
The default date format of the user. |
| DecimalSeparator | String | False |
The locale of the default decimal separator of the user. |
| TimeZone | String | False |
The time zone of the user. |
| Zuid | String | True |
The default ZUID of the user. |
| CreatedByName | String | True |
The name of the user who created this user. |
| CreatedById | String | True |
The id of the user who created this user. |
| CreatedAt | Datetime | True |
The time this user was created. |
| ModifiedByName | String | True |
The name of the user who modified this user. |
| ModifiedById | String | True |
The id of the user who modified this user. |
| ModifiedAt | Datetime | True |
The time this user was last modified. |
| NumberSeparator | String | False |
Represents the format of the number fields. The possible values are comma, period and space. |
| CustomizeInfoNotesDesc | String | True |
The Customize info notes description. |
| CustomizeInfoShowRightPanel | Boolean | True |
The Customize info show right panel. |
| CustomizeInfoShowLeftPanel | Boolean | True |
The Customize info show left panel. |
| CustomizeInfoBcView | String | True |
The Customize info bc view. |
| CustomizeInfoShowHome | Boolean | True |
The Customize info show home. |
| CustomizeInfoShowDetailView | Boolean | True |
The Customize info show detail view. |
| CustomizeInfoUnpinRecentItem | String | True |
The Customize info unpin recent item. |
| Microsoft | Boolean | True |
Represents if the user is a microsoft user. |
| ThemeBackground | String | True |
The theme background. |
| ThemeNewBackground | String | True |
The theme new background. |
| ThemeNormalTabBackground | String | True |
The theme normal tab background. |
| ThemeNormalTabFontColor | String | True |
The theme normal tab font color. |
| ThemeScreen | String | True |
The theme screen. |
| ThemeSelectedTabBackground | String | True |
The theme selected tab background. |
| ThemeSelectedTabFontColor | String | True |
The theme selected tab font color. |
| ThemeType | String | True |
The theme type. |
| ReportingToName | String | True |
Represents the name of the user to whom the user reports to. |
| ReportingToId | String | False |
Represents the id of the user to whom the user reports to. |
| Offset | Integer | True |
Offset. |
| SandboxDeveloper | Boolean | True |
Sandbox Developer. |
| Category | String | True |
The category of the user. |
| SortOrderPreference | String | False |
Represents how the records in the response are sorted based on either the last name or first name. The default sorting happens by the record IDs. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| Type | String |
Limit the users returned to the ones of this type The allowed values are AllUsers, ActiveUsers, DeactiveUsers, ConfirmedUsers, NotConfirmedUsers, DeletedUsers, ActiveConfirmedUsers, AdminUsers, ActiveConfirmedAdmins, CurrentUser. |