List all porting phone numbers

Returns a list of your porting phone numbers.

GET /porting/phone_numbers

JavaScript

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 portingPhoneNumberListResponse of client.portingPhoneNumbers.list()) {
  console.log(portingPhoneNumberListResponse.porting_order_id);
}

200

{
  "data": [
    {
      "porting_order_status": "in-process",
      "phone_number_type": "local",
      "phone_number": "13035550987",
      "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "support_key": "sr_a12345",
      "activation_status": "Active",
      "portability_status": "confirmed",
      "requirements_status": "approved",
      "record_type": "porting_phone_number"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "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]

Show child attributes

filter · object

Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]

Show child attributes

Response

200

application/json

Successful response

data · object[]

Show child attributes

meta · object

Show child attributes