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

Get a list of all IPs.

<Note>
  External Documentation

  To learn more, visit the [Device 42 documentation](https://api.device42.com/#IPAM_getIPAM_ips_0).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter   | Description                                                                      |
  | ----------- | -------------------------------------------------------------------------------- |
  | Device      | The name of the device to filter the results by.                                 |
  | IP          | An IP address to get details on.                                                 |
  | IP ID       | The ID of the IP to filter the results by.                                       |
  | Limit       | The maximum number of objects to return in the response.                         |
  | Offset      | The pagination offset indicating the starting point for the next set of results. |
  | Subnet ID   | The ID of the subnet to filter the results by.                                   |
  | Subnet Name | The name of the subnet to filter the results by.                                 |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter           | Description                                                                                                             |
  | ------------------- | ----------------------------------------------------------------------------------------------------------------------- |
  | AND Tags            | A comma-separated list of tags to filter by (AND related - return results that include all the tags).                   |
  | Available           | Filter the results by availability.                                                                                     |
  | Custom Fields (AND) | A comma-separated list of custom fields to filter the results by (AND). Format - `key1:value1,key2:value2`              |
  | Custom Fields (OR)  | A comma-separated list of custom fields to filter the results by (OR). Format - `key1:value1,key2:value2`               |
  | First Added After   | Filter objects first added after or on the given date .                                                                 |
  | First Added Before  | Filter objects first added before the given date.                                                                       |
  | Is Shared           | Select to include list of shared devices for each IP address.                                                           |
  | Label               | The label to filter the results by.                                                                                     |
  | Last Updated After  | Filter objects last updated after or on the given date.                                                                 |
  | Last Updated Before | Filter objects last updated before the given date.                                                                      |
  | Mac                 | The mac address to filter the results by.                                                                               |
  | Tags                | A comma-separated list of tags to filter results by (OR filter - return results that include at least one of the tags). |
  | Type                | The type of IP to filter the results by.                                                                                |
</div>

## Example Output

```json theme={"dark"}
{
	"ips": [
		{
			"available": "no",
			"custom_fields": [
				{
					"key": "test",
					"notes": "",
					"value": ""
				}
			],
			"id": 38,
			"ip": "10.1.10.5",
			"label": "",
			"last_updated": "2015-11-12T17:31:57.985Z",
			"mac_address": "",
			"mac_id": "",
			"notes": "",
			"subnet": "Infra-10.1.10.0/24(Infrastructure Services)",
			"subnet_id": 5,
			"type": "Reserved",
			"is_shared": false,
			"devices": [
				{
					"device_id": 4924,
					"name": "17R0TW1",
					"locked": false
				}
			]
		},
		{
			"available": "no",
			"custom_fields": [
				{
					"key": "test",
					"notes": "",
					"value": ""
				}
			],
			"id": 41,
			"ip": "10.1.20.6",
			"label": "",
			"last_updated": "2017-06-12T17:31:57.985Z",
			"mac_address": "",
			"mac_id": "",
			"notes": "",
			"subnet": "Infra-10.1.20.0/24(Infrastructure Services)",
			"subnet_id": 7,
			"type": "Reserved",
			"is_shared": false,
			"resource": {
				"id": 42,
				"name": "DEFAULT",
				"identifier": "boot/DEFAULT"
			},
			"devices": []
		}
	],
	"limit": 4,
	"offset": 0,
	"total_count": 1004
}
```

## Workflow Library Example

[List Ips with Device 42 and Send Results Via Email](https://library.blinkops.com/workflows/list-ips-with-device-42-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-ips-with-device-42-and-send-results-via-email/canvas" />
</div>