> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Agents

List the agents configured in Halo ITSM.

> [!NOTE]
>
> External Documentation
>
> To learn more, visit the [Halo ITSM documentation](https://www.usehalo.com/swagger).

## 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

```json theme={"dark"}
[
	{
		"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
	}
]
```

## Workflow Library Example

[List Agents with Halo Itsm and Send Results Via Email](https://library.blinkops.com/workflows/list-agents-with-halo-itsm-and-send-results-via-email)

![Workflow Library](https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max\&auto=format\&n=ojHYuDeYX5FWuN8a\&q=85\&s=b8af968e71438a9499c3223c9bd29fb2)

Preview this Workflow on desktop

[https://library.blinkops.com/workflows/list-agents-with-halo-itsm-and-send-results-via-email/canvas](https://library.blinkops.com/workflows/list-agents-with-halo-itsm-and-send-results-via-email/canvas)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.