Agents
To view the agents in the Zoho Desk
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
ID of the agent | |
| LastName | String | False |
Last name of the agent | |
| Name | String | True |
Full name of the agent | |
| firstName | String | False |
First name of the agent | |
| EmailId | String | False |
Email ID of the agent | |
| Status | String | False |
Activation status of the agent: ACTIVE or DISABLED The allowed values are ACTIVE, DISABLED, DELETED, IMPORTED. | |
| RoleId | String | False |
Role ID of the agent | |
| RolePermissionType | String | False |
The Role Permission type of Agent | |
| AboutInfo | String | True |
Agent's about info | |
| AssociatedChatDepartmentIds | String | True |
Chat departments with which the agent is associated | |
| AssociatedDepartmentIds | String | False |
Departments with which the agent is associated | |
| ChannelExpert | String | True |
Channel Expert | |
| CountryCode | String | True |
Country code of the agent. | |
| Extension | String | True |
Extension number of the agent | |
| IsConfirmed | Boolean | True |
Key that returns if the agent is a confirmed user in the portal or not | |
| LanguageCode | String | True |
Language code of the agent. | |
| Mobile | String | False |
Mobile number of the agent | |
| Phone | String | False |
Phone number of the agent | |
| PhotoURL | String | True |
URL of the image file displaying the agent photo | |
| ProfileId | String | False |
Profile ID of the agent | |
| TimeZone | String | True |
The timeZone of the agent. Eg Asia/Calcutta, Europe/Moscow. | |
| ZuId | String | True |
Zoho user ID of the agent |
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 |
| FilterFieldName | String |
Name of the field that must be used for searching and listing agents. The allowed values are: firstName, lastName, name, and emailId |
| Include | String |
The allowed values are owner and departments for retrieving individual records, whereas for listing records, only owner is supported. |
| SearchString | String |
String to search for agents by first name, last name, or email ID |
| IsLightAgent | Boolean |
Key that denotes if the agents must be light or non light. |
| DepartmentIds | String |
Department ID of the agent |