Agents
Update, delete, and query from agents table
Table Specific Information
Select
The add-in will use the Freshdesk API to process WHERE clause conditions built with the following columns and operators. Most of the columns support server side filtering with the following operators: =,>,<,<=,>=,AND,OR. The rest of the filter is executed client side within the add-in.
For example, the following query is processed server side:
SELECT * FROM Agents WHERE Id = 100
Note: To query Agents table, All Agent APIs other than the Currently Authenticated Agent API require admin privileges.
Update
Following is an example of how to update an agent:
UPDATE Agents SET GroupIdsAggregate = '111' WHERE Id = 100
Delete
Following is an example of how to delete an agent:
DELETE FROM Agents WHERE Id = 100
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Bigint | False |
ID of the agent. |
| Available | Boolean | True |
Indicates if agent is taking new tickets. |
| GroupIdsAggregate | String | False |
Group IDs associated with the agent. |
| Occasional | Boolean | True |
True if this is an occasional agent. |
| RoleIdsAggregate | String | False |
Role IDs associated with the agent. |
| Signature | String | True |
Signature of the agent in HTML format. |
| SkillIdsAggregate | String | True |
Skill ids associated with the agent. |
| TicketScope | Integer | True |
Ticket permission of the agent (1 -> Global Access, 2 -> Group Access, 3 -> Restricted Access). |
| AgentActive | Boolean | True |
Whether or not the agent has been verified. |
| AgentEmail | String | True |
Email address of the agent. |
| AgentJobTitle | String | True |
Job title of the agent. |
| AgentLanguage | String | True |
Language of the agent. |
| AgentLastLogin | Datetime | True |
Last login date of the agent. |
| AgentMobile | String | True |
Mobile phone number of the agent. |
| AgentName | String | True |
Name of the agent. |
| AgentPhone | String | True |
Telephone number of the agent. |
| AgentTimeZone | String | True |
Time zone of the agent. |
| AgentCreatedAt | Datetime | True |
Created at datetime of the agent. |
| AgentUpdatedAt | Datetime | True |
Updated at datetime of the agent. |
| CreatedAt | Datetime | True |
Agent creation timestamp. |
| UpdatedAt | Datetime | True |
Agent updated timestamp. |
| AvailableSince | Datetime | True |
Timestamp that denotes when the agent became available/unavailable. |