Skip to main content
GET
/
phone_numbers
/
slim
JavaScript
import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const phoneNumberSlimListResponse of client.phoneNumbers.slimList()) {
  console.log(phoneNumberSlimListResponse.id);
}
{
  "data": [
    {
      "id": "1293384261075731499",
      "record_type": "phone_number",
      "phone_number": "+19705555098",
      "country_iso_alpha2": "US",
      "status": "active",
      "external_pin": "1234",
      "connection_id": "1293384261075731499",
      "customer_reference": "customer-reference",
      "billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
      "emergency_enabled": true,
      "emergency_address_id": "1315261609962112019",
      "emergency_status": "active",
      "call_forwarding_enabled": true,
      "cnam_listing_enabled": true,
      "caller_id_name_enabled": true,
      "call_recording_enabled": true,
      "t38_fax_gateway_enabled": true,
      "phone_number_type": "local",
      "inbound_call_screening": "disabled",
      "purchased_at": "2019-10-23T18:10:00.000Z",
      "created_at": "2019-10-23T18:10:00.000Z",
      "updated_at": "2019-10-24T18:10:00.000Z",
      "hd_voice_enabled": true
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

​
include_connection
boolean
default:false

Include the connection associated with the phone number.

​
include_tags
boolean
default:false

Include the tags associated with the phone number.

​
sort
enum<string>

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Available options:
purchased_at,
phone_number,
connection_name,
usage_payment_method
Example:

"connection_name"

​
filter
object

Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[phone_number], filter[status], filter[country_iso_alpha2], filter[connection_id], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference], filter[number_type], filter[source]

Response

Successful response with a list of phone numbers.

​
data
object[]
​
meta
object