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

# Get IP Address

Get a list of IP addresses.

**Important Note:** This action is only available when using the `V2` connection method of BlueCat Address Manager.

<Note>
  External Documentation

  To learn more, visit the [BlueCat Address Manager documentation](https://docs.bluecatnetworks.com/r/Address-Manager-RESTful-v2-API-Guide/Introduction/9.6.0).
</Note>

## Parameters

<div className="integrations-table">
  | Parameter             | Description                                                                                                |
  | --------------------- | ---------------------------------------------------------------------------------------------------------- |
  | Fields                | A comma-separated list of fields to include in the response. <br /><br />**For example** - `id,name,type`. |
  | Filter                | A criteria to filter the results by.                                                                       |
  | Include Total Results | Select to get the total number of results in the response.                                                 |
  | Limit                 | The maximum number of results to return per page.                                                          |
  | Offset                | The pagination offset indicating the starting point for the next set of results.                           |
  | Order By              | The attribute to sort the results with.                                                                    |
  | Return All Pages      | Automatically fetch all resources, page by page.                                                           |
</div>

## Example Output

```json theme={"dark"}
{
	"_links": {
		"next": {
			"href": "/api/v2/addresses?offset=2000&limit=1000"
		},
		"prev": {
			"href": "/api/v2/addresses?offset=0&limit=1000"
		}
	},
	"count": 0,
	"totalCount": 0,
	"data": [
		{
			"id": 12345,
			"type": "IPv4Address",
			"name": "name",
			"userDefinedFields": {
				"udf1": "value1",
				"udf2": "value2"
			},
			"configuration": {
				"id": 12345,
				"type": "Configuration",
				"name": "name"
			},
			"state": "UNASSIGNED",
			"address": "string",
			"macAddress": {
				"id": 12345,
				"type": "MACAddress",
				"name": "name",
				"address": "00-00-5E-00-53-AF"
			},
			"device": {
				"id": 12345,
				"type": "Device",
				"name": "device0"
			},
			"location": {
				"id": 12345,
				"type": "Location",
				"name": "name"
			},
			"leaseDateTime": "2022-01-15T00:00:00Z",
			"leaseExpirationDateTime": "2022-01-25T00:00:00Z",
			"remoteId": "1234",
			"ipGroup": {
				"id": 12345,
				"type": "IPv4Group",
				"name": "Example IPv4 Group"
			},
			"template": {
				"id": 12345,
				"type": "IPv4Template",
				"name": "name"
			},
			"circuitId": "123",
			"routerPortInfo": "string",
			"switchPortInfo": "string",
			"vlanInfo": "string",
			"vendorClassIdentifier": "string",
			"parameterRequestList": [
				0
			],
			"clientIdentifier": {
				"id": 12345,
				"type": "DHCPClientIdentifier",
				"name": "name",
				"uid": {
					"clientIdentifier": "string"
				}
			},
			"_links": {
				"self": {
					"href": "/addresses/12345"
				},
				"collection": {
					"href": "/addresses"
				}
			}
		},
		{
			"id": 12345,
			"type": "IPv6Address",
			"name": "name",
			"userDefinedFields": {
				"udf1": "value1",
				"udf2": "value2"
			},
			"configuration": {
				"id": 12345,
				"type": "Configuration",
				"name": "name"
			},
			"state": "UNASSIGNED",
			"address": "string",
			"macAddress": {
				"id": 12345,
				"type": "MACAddress",
				"name": "name",
				"address": "00-00-5E-00-53-AF"
			},
			"device": {
				"id": 12345,
				"type": "Device",
				"name": "device0"
			},
			"location": {
				"id": 12345,
				"type": "Location",
				"name": "name"
			},
			"leaseDateTime": "2022-01-15T00:00:00Z",
			"leaseExpirationDateTime": "2022-01-25T00:00:00Z",
			"remoteId": "1234",
			"reservedUsing": "CLIENT_DUID",
			"identityAssociationIdentifier": "00040001",
			"clientIdentifier": {
				"id": 12345,
				"type": "DHCPUniqueIdentifier",
				"name": "name",
				"duid": "string"
			},
			"interfaceId": "123",
			"_links": {
				"self": {
					"href": "/addresses/12345"
				},
				"collection": {
					"href": "/addresses"
				}
			}
		}
	]
}
```

## Workflow Library Example

[Get Ip Address with Bluecat Address Manager and Send Results Via Email](https://library.blinkops.com/workflows/get-ip-address-with-bluecat-address-manager-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/get-ip-address-with-bluecat-address-manager-and-send-results-via-email/canvas" />
</div>
