External DocumentationTo learn more, visit the Halo ITSM documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Department ID | The ID of the department to filter agents by. |
| Include Disabled Agents | Select to include disabled agents in the response. |
| Include Enabled Agents | Select to include enabled agents in the response. |
| Include Unassigned Agent | Select to include Halo’s built-in unassigned agent in the response. |
| Search | The name, email address, or telephone number to filter agents by. |
| Team | The name of the team to filter agents by. |
| Team ID | The ID of the team to filter agents by. Can be obtained from the List Teams action. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Client ID | The ID of the client to filter agents by, returning agents who have access to that client. |
| Role ID | The ID of the role to filter agents by. |
Example Output
[
{
"id": 0,
"name": "string",
"onlinestatus": 0,
"lastonline": "string",
"team": "string",
"isdisabled": true,
"email": "string",
"ad": "string",
"lastlogindate": "2017-11-01T16:03:33.030Z",
"agentphotopath": "string",
"initials": "string",
"firstname": "string",
"surname": "string",
"colour": "string",
"ticket_count": 0
}
]