Skip to main content
GET
/
v2
/
list-phone-numbers
JavaScript
import Retell from 'retell-sdk';

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

const phoneNumbers = await client.phoneNumber.list();

console.log(phoneNumbers.has_more);
{
  "pagination_key": "<string>",
  "has_more": true,
  "items": [
    {
      "phone_number": "+14157774444",
      "phone_number_type": "retell-twilio",
      "last_modification_timestamp": 1703413636133,
      "phone_number_pretty": "+1 (415) 777-4444",
      "allowed_inbound_country_list": [
        "US",
        "CA",
        "GB"
      ],
      "allowed_outbound_country_list": [
        "US",
        "CA"
      ],
      "area_code": 415,
      "inbound_agents": [
        {
          "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
          "weight": 0.5,
          "agent_version": 1
        }
      ],
      "outbound_agents": [
        {
          "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
          "weight": 0.5,
          "agent_version": 1
        }
      ],
      "inbound_sms_agents": [
        {
          "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
          "weight": 0.5,
          "agent_version": 1
        }
      ],
      "outbound_sms_agents": [
        {
          "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
          "weight": 0.5,
          "agent_version": 1
        }
      ],
      "nickname": "Frontdesk Number",
      "inbound_webhook_url": "https://example.com/inbound-webhook",
      "inbound_sms_webhook_url": "https://example.com/inbound-sms-webhook",
      "sip_outbound_trunk_config": {
        "termination_uri": "someuri.pstn.twilio.com",
        "auth_username": "username",
        "transport": "TCP"
      },
      "fallback_number": "+14155551234"
    }
  ]
}

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Query Parameters

limit
integer
default:50

Maximum number of items to return.

Required range: x <= 1000
sort_order
enum<string>
default:descending

Sort order for results.

Available options:
ascending,
descending
pagination_key
string

Pagination key for fetching the next page.

Response

Successfully retrieved phone numbers.

pagination_key
string

Pagination key for the next page.

has_more
boolean

Whether more results are available.

items
object[]