Retrieve an IP pool

GET

ip_pools

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const IpPoolShow = await client.email.ipPools.retrieve('id');

console.log(IpPoolShow.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
ip_pool_show = client.email.ip_pools.retrieve(
    "id",
)
print(ip_pool_show.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	iPPool, err := client.Email.IPPools.Get(
		context.TODO(),
		"id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", iPPool.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var response = client.email().ipPools().retrieve("id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $ip_pool_show = $client->email->ipPools->retrieve(
    'id',
  );

  var_dump($ip_pool_show);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "data": {
    "id": "9b1c4d70-abcd-4e5f-8a9b-0c1d2e3f4a5b",
    "record_type": "ip_pool",
    "name": "primary-pool",
    "is_default": true,
    "domain_id": null,
    "ips": [
      {
        "id": "6a7f9a30-1234-4b5c-8d9e-0f1a2b3c4d5e",
        "record_type": "dedicated_ip",
        "ip_address": "64.16.239.170",
        "ip_version": "ipv4",
        "pool_id": "9b1c4d70-abcd-4e5f-8a9b-0c1d2e3f4a5b",
        "region": "ewr-nj1",
        "status": "active",
        "warmup": {
          "started_at": "2026-09-15T00:00:00.000000Z",
          "progress": 100,
          "daily_cap": null,
          "paused": false,
          "paused_at": null,
          "today": {
            "day": "2026-10-24",
            "cap": 100000000,
            "granted": 0,
            "remaining": 100000000
          }
        },
        "billing": {
          "status": "active",
          "charged": true
        },
        "provisioning_status": "dns_confirmed",
        "provisioning": {
          "dns_status": "dns_confirmed",
          "ptr_request_state": "confirmed",
          "ptr_request_pr_url": null,
          "checklist": {
            "ptr_requested": true,
            "ptr_authored": false,
            "ptr_merged": true,
            "forward_confirmed": true
          }
        },
        "ptr_hostname": "mta-64-16-239-170.msgtelnyx.com",
        "dns_confirmed_at": "2026-10-14T20:12:41.552310Z",
        "quarantine_until": null,
        "released_at": null,
        "suspension_reason": null,
        "created_at": "2026-09-30T02:03:09.474123Z",
        "updated_at": "2026-10-20T04:00:03.402117Z",
        "weight": 100
      }
    ],
    "created_at": "2026-09-30T02:03:09.474123Z",
    "updated_at": "2026-09-30T02:03:09.474123Z"
  }
}

{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested ip pool was not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Path Parameters

string<uuid>

required

The IP pool identifier (UUID).

Response

IP pool details

data

object

required

An account-scoped pool of dedicated IPs. Mail uses a pool only when the pool is scoped to the sending domain (domain_id) or is the account default (is_default).

Show child attributes

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const IpPoolShow = await client.email.ipPools.retrieve('id');

console.log(IpPoolShow.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
ip_pool_show = client.email.ip_pools.retrieve(
    "id",
)
print(ip_pool_show.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	iPPool, err := client.Email.IPPools.Get(
		context.TODO(),
		"id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", iPPool.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var response = client.email().ipPools().retrieve("id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $ip_pool_show = $client->email->ipPools->retrieve(
    'id',
  );

  var_dump($ip_pool_show);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "data": {
    "id": "9b1c4d70-abcd-4e5f-8a9b-0c1d2e3f4a5b",
    "record_type": "ip_pool",
    "name": "primary-pool",
    "is_default": true,
    "domain_id": null,
    "ips": [
      {
        "id": "6a7f9a30-1234-4b5c-8d9e-0f1a2b3c4d5e",
        "record_type": "dedicated_ip",
        "ip_address": "64.16.239.170",
        "ip_version": "ipv4",
        "pool_id": "9b1c4d70-abcd-4e5f-8a9b-0c1d2e3f4a5b",
        "region": "ewr-nj1",
        "status": "active",
        "warmup": {
          "started_at": "2026-09-15T00:00:00.000000Z",
          "progress": 100,
          "daily_cap": null,
          "paused": false,
          "paused_at": null,
          "today": {
            "day": "2026-10-24",
            "cap": 100000000,
            "granted": 0,
            "remaining": 100000000
          }
        },
        "billing": {
          "status": "active",
          "charged": true
        },
        "provisioning_status": "dns_confirmed",
        "provisioning": {
          "dns_status": "dns_confirmed",
          "ptr_request_state": "confirmed",
          "ptr_request_pr_url": null,
          "checklist": {
            "ptr_requested": true,
            "ptr_authored": false,
            "ptr_merged": true,
            "forward_confirmed": true
          }
        },
        "ptr_hostname": "mta-64-16-239-170.msgtelnyx.com",
        "dns_confirmed_at": "2026-10-14T20:12:41.552310Z",
        "quarantine_until": null,
        "released_at": null,
        "suspension_reason": null,
        "created_at": "2026-09-30T02:03:09.474123Z",
        "updated_at": "2026-10-20T04:00:03.402117Z",
        "weight": 100
      }
    ],
    "created_at": "2026-09-30T02:03:09.474123Z",
    "updated_at": "2026-09-30T02:03:09.474123Z"
  }
}

{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested ip pool was not found"
    }
  ]
}

Getting Started

Sending Email

Inboxes

Domains & Validation

Deliverability

Templates & Suppression

Events & Webhooks

For AI Agents

Retrieve an IP pool

Authorizations

Path Parameters

Response