Open SidemenuAPI Reference
API Reference
Close Sidemenu

Porting Order

List all porting orderslistPortingOrders

get https://api.telnyx.com/v2/porting_orders

Returns a list of your porting order.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/porting_orders?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load.

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page.

Default: 20
include_phone_numbers
boolean
optional

Include the first 50 phone number objects in the results

Default: true
filter[status]
object
optional

Porting order status

filter[customer_reference]
string
optional

Filter results by user reference

Example: "123abc"
filter[phone_numbers][country_code]
string
optional

Filter results by country ISO 3166-1 alpha-2 code

Example: "US"
filter[phone_numbers][carrier_name]
string
optional

Filter results by old service provider

Example: "Telnyx"
filter[misc][type]
string
optional

A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.

Example: "full"
Options: [ "full", "partial" ]
filter[end_user][admin][entity_name]
string
optional

Filter results by person or company name

Example: "Porter McPortersen"
filter[end_user][admin][auth_person_name]
string
optional

Filter results by authorized person

Example: "Admin McPortersen"
filter[activation_settings][fast_port_eligible]
boolean
optional

Filter results by fast port eligible

filter[activation_settings][foc_datetime_requested][gt]
string
optional

Filter results by foc date later than this value

Example: "2021-03-25T10:00:00.000Z"
filter[activation_settings][foc_datetime_requested][lt]
string
optional

Filter results by foc date earlier than this value

Example: "2021-03-25T10:00:00.000Z"
sort
string
optional

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

Example: "created_at"
Options: [ "created_at", "-created_at", "activation_settings.foc_datetime_requested", "-activation_settings.foc_datetime_requested" ]
Responses
200

Successful response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": [
    {
      "activation_settings": {
        "activation_status": "Active",
        "fast_port_eligible": true,
        "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
        "foc_datetime_requested": "2021-03-19T10:07:15.527Z"
      },
      "created_at": "2021-03-19T10:07:15.527Z",
      "end_user": {
        "admin": {
          "account_number": "123abc",
          "auth_person_name": "Porter McPortersen II",
          "billing_phone_number": 13035551234,
          "business_identifier": "abc123",
          "entity_name": "Porter McPortersen",
          "pin_passcode": 1234,
          "tax_identifier": "1234abcd"
        },
        "location": {
          "administrative_area": "IL",
          "country_code": "US",
          "extended_address": "Suite 504",
          "locality": "Chicago",
          "postal_code": "60654",
          "premises": "Mill House",
          "street_address": "311 W. Superior St"
        }
      },
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "misc": {
        "new_billing_phone_number": "string",
        "remaining_numbers_action": "disconnect",
        "type": "full"
      },
      "old_service_provider_ocn": "Unreal Communications",
      "phone_number_configuration": {
        "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
        "tags": [
          "abc",
          "123"
        ]
      },
      "porting_phone_numbers_count": 1,
      "record_type": "porting_order",
      "requirements": [
        {
          "field_type": "document",
          "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
          "record_type": "porting_requirement",
          "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
        }
      ],
      "status": {
        "details": [
          {
            "code": "ENTITY_NAME_MISMATCH",
            "description": "Entity name does not match that on the CSR"
          }
        ],
        "value": "ported"
      },
      "support_key": "123abc",
      "updated_at": "2021-03-19T10:07:15.527Z",
      "user_feedback": {
        "user_comment": "I loved my experience porting numbers with Telnyx",
        "user_rating": 5
      },
      "user_reference": "Acct 123abc",
      "webhook_url": "https://example.com/porting_webhooks"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Create a porting ordercreatePortingOrder

post https://api.telnyx.com/v2/porting_orders

Creates a new porting order object.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"phone_numbers":["+13035550000","+13035550001","+13035550002"]}' \
  https://api.telnyx.com/v2/porting_orders
Parameters
In body (application/json)
phone_numbers
array of string
required

The list of +E.164 formatted phone numbers

Example: [ "+13035550000", "+13035550001", "+13035550002" ]
Responses
201

Successful response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": [
    {
      "activation_settings": {
        "activation_status": "Active",
        "fast_port_eligible": true,
        "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
        "foc_datetime_requested": "2021-03-19T10:07:15.527Z"
      },
      "created_at": "2021-03-19T10:07:15.527Z",
      "end_user": {
        "admin": {
          "account_number": "123abc",
          "auth_person_name": "Porter McPortersen II",
          "billing_phone_number": 13035551234,
          "business_identifier": "abc123",
          "entity_name": "Porter McPortersen",
          "pin_passcode": 1234,
          "tax_identifier": "1234abcd"
        },
        "location": {
          "administrative_area": "IL",
          "country_code": "US",
          "extended_address": "Suite 504",
          "locality": "Chicago",
          "postal_code": "60654",
          "premises": "Mill House",
          "street_address": "311 W. Superior St"
        }
      },
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "misc": {
        "new_billing_phone_number": "string",
        "remaining_numbers_action": "disconnect",
        "type": "full"
      },
      "old_service_provider_ocn": "Unreal Communications",
      "phone_number_configuration": {
        "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
        "tags": [
          "abc",
          "123"
        ]
      },
      "porting_phone_numbers_count": 1,
      "record_type": "porting_order",
      "requirements": [
        {
          "field_type": "document",
          "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
          "record_type": "porting_requirement",
          "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
        }
      ],
      "status": {
        "details": [
          {
            "code": "ENTITY_NAME_MISMATCH",
            "description": "Entity name does not match that on the CSR"
          }
        ],
        "value": "ported"
      },
      "support_key": "123abc",
      "updated_at": "2021-03-19T10:07:15.527Z",
      "user_feedback": {
        "user_comment": "I loved my experience porting numbers with Telnyx",
        "user_rating": 5
      },
      "user_reference": "Acct 123abc",
      "webhook_url": "https://example.com/porting_webhooks"
    }
  ]
}

List all exception typeslistPortingOrdersExceptionTypes

get https://api.telnyx.com/v2/porting_orders/exception_types

Returns a list of all possible exception types for a porting order.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/porting_orders/exception_types"
Parameters
Responses
200

Successful response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": [
    {
      "code": "ENTITY_NAME_MISMATCH",
      "description": "Entity name does not match that on the CSR"
    }
  ]
}

Retrieve a porting ordergetPortingOrder

get https://api.telnyx.com/v2/porting_orders/{id}

Retrieves the details of an existing porting order.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/porting_orders/{id}?include_phone_numbers=true"
Parameters
In path
id
string (uuid)
required

Porting Order id

In query
include_phone_numbers
boolean
optional

Include the first 50 phone number objects in the results

Default: true
Responses
200

Successful response

401

Unauthorized

Success Response
{
  "data": {
    "activation_settings": {
      "activation_status": "Active",
      "fast_port_eligible": true,
      "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
      "foc_datetime_requested": "2021-03-19T10:07:15.527Z"
    },
    "created_at": "2021-03-19T10:07:15.527Z",
    "end_user": {
      "admin": {
        "account_number": "123abc",
        "auth_person_name": "Porter McPortersen II",
        "billing_phone_number": 13035551234,
        "business_identifier": "abc123",
        "entity_name": "Porter McPortersen",
        "pin_passcode": 1234,
        "tax_identifier": "1234abcd"
      },
      "location": {
        "administrative_area": "IL",
        "country_code": "US",
        "extended_address": "Suite 504",
        "locality": "Chicago",
        "postal_code": "60654",
        "premises": "Mill House",
        "street_address": "311 W. Superior St"
      }
    },
    "id": "f1486bae-f067-460c-ad43-73a92848f902",
    "misc": {
      "new_billing_phone_number": "string",
      "remaining_numbers_action": "disconnect",
      "type": "full"
    },
    "old_service_provider_ocn": "Unreal Communications",
    "phone_number_configuration": {
      "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
      "tags": [
        "abc",
        "123"
      ]
    },
    "porting_phone_numbers_count": 1,
    "record_type": "porting_order",
    "requirements": [
      {
        "field_type": "document",
        "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
        "record_type": "porting_requirement",
        "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
      }
    ],
    "status": {
      "details": [
        {
          "code": "ENTITY_NAME_MISMATCH",
          "description": "Entity name does not match that on the CSR"
        }
      ],
      "value": "ported"
    },
    "support_key": "123abc",
    "updated_at": "2021-03-19T10:07:15.527Z",
    "user_feedback": {
      "user_comment": "I loved my experience porting numbers with Telnyx",
      "user_rating": 5
    },
    "user_reference": "Acct 123abc",
    "webhook_url": "https://example.com/porting_webhooks"
  },
  "meta": {
    "phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
  }
}

Edit a porting orderupdatePortingOrder

patch https://api.telnyx.com/v2/porting_orders/{id}

Edits the details of an existing porting order.

Any or all of a porting order’s attributes may be included in the resource object included in a PATCH request.

If a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values. To explicitly set something to null, it must be included in the request with a null value.

curl -X PATCH \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"activation_settings":{},"customer_reference":"string"}' \
  https://api.telnyx.com/v2/porting_orders/{id}
Parameters
In path
id
string (uuid)
required

Porting Order id

In body (application/json)
activation_settings
object
optional
customer_reference
string
optional
end_user
object
optional
misc
object
optional
phone_number_configuration
object
optional
requirements
array of object
optional

List of requirements for porting numbers.

field_value
string

identifies the document that satisfies this requirement

Example: "9787fb5f-cbe5-4de4-b765-3303774ee9fe"
requirement_type_id
string

Identifies the requirement type that meets this requirement

Example: "59b0762a-b274-4f76-ac32-4d5cf0272e66"
user_feedback
object
optional
webhook_url
string (uri)
optional
Responses
200

Successful response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": {
    "activation_settings": {
      "activation_status": "Active",
      "fast_port_eligible": true,
      "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
      "foc_datetime_requested": "2021-03-19T10:07:15.527Z"
    },
    "created_at": "2021-03-19T10:07:15.527Z",
    "end_user": {
      "admin": {
        "account_number": "123abc",
        "auth_person_name": "Porter McPortersen II",
        "billing_phone_number": 13035551234,
        "business_identifier": "abc123",
        "entity_name": "Porter McPortersen",
        "pin_passcode": 1234,
        "tax_identifier": "1234abcd"
      },
      "location": {
        "administrative_area": "IL",
        "country_code": "US",
        "extended_address": "Suite 504",
        "locality": "Chicago",
        "postal_code": "60654",
        "premises": "Mill House",
        "street_address": "311 W. Superior St"
      }
    },
    "id": "f1486bae-f067-460c-ad43-73a92848f902",
    "misc": {
      "new_billing_phone_number": "string",
      "remaining_numbers_action": "disconnect",
      "type": "full"
    },
    "old_service_provider_ocn": "Unreal Communications",
    "phone_number_configuration": {
      "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
      "tags": [
        "abc",
        "123"
      ]
    },
    "porting_phone_numbers_count": 1,
    "record_type": "porting_order",
    "requirements": [
      {
        "field_type": "document",
        "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
        "record_type": "porting_requirement",
        "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
      }
    ],
    "status": {
      "details": [
        {
          "code": "ENTITY_NAME_MISMATCH",
          "description": "Entity name does not match that on the CSR"
        }
      ],
      "value": "ported"
    },
    "support_key": "123abc",
    "updated_at": "2021-03-19T10:07:15.527Z",
    "user_feedback": {
      "user_comment": "I loved my experience porting numbers with Telnyx",
      "user_rating": 5
    },
    "user_reference": "Acct 123abc",
    "webhook_url": "https://example.com/porting_webhooks"
  },
  "meta": {
    "phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
  }
}

List all porting activation jobslistPortingOrdersActivationJobs

get https://api.telnyx.com/v2/porting_orders/{id}/activation_jobs

Returns a list of your porting activation jobs.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/porting_orders/{id}/activation_jobs?page[number]=1&page[size]=20"
Parameters
In path
id
string (uuid)
required

Porting Order id

In query
page[number]
integer (1)
optional

The page number to load.

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page.

Default: 20
Responses
200

Successful response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": [
    {
      "created_at": "2021-03-19T10:07:15.527Z",
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "record_type": "porting_activation_job",
      "status": "created",
      "updated_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Download a porting order loa templategetPortingOrderLOATemplate

get https://api.telnyx.com/v2/porting_orders/{id}/loa_template

Download a porting order loa template

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/porting_orders/{id}/loa_template"
Parameters
In path
id
string (uuid)
required

Porting Order id

Responses
200

Successful response

401

Unauthorized

Success Response
PDF
string (binary)

Confirms the porting order is ready to be actioned.confirmPortingOrder

post https://api.telnyx.com/v2/porting_orders/{id}/actions/confirm

Confirm your porting order.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{}' \
  https://api.telnyx.com/v2/porting_orders/{id}/actions/confirm
Parameters
In path
id
string (uuid)
required

Porting Order id

Responses
200

Successful response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": {
    "activation_settings": {
      "activation_status": "Active",
      "fast_port_eligible": true,
      "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
      "foc_datetime_requested": "2021-03-19T10:07:15.527Z"
    },
    "created_at": "2021-03-19T10:07:15.527Z",
    "end_user": {
      "admin": {
        "account_number": "123abc",
        "auth_person_name": "Porter McPortersen II",
        "billing_phone_number": 13035551234,
        "business_identifier": "abc123",
        "entity_name": "Porter McPortersen",
        "pin_passcode": 1234,
        "tax_identifier": "1234abcd"
      },
      "location": {
        "administrative_area": "IL",
        "country_code": "US",
        "extended_address": "Suite 504",
        "locality": "Chicago",
        "postal_code": "60654",
        "premises": "Mill House",
        "street_address": "311 W. Superior St"
      }
    },
    "id": "f1486bae-f067-460c-ad43-73a92848f902",
    "misc": {
      "new_billing_phone_number": "string",
      "remaining_numbers_action": "disconnect",
      "type": "full"
    },
    "old_service_provider_ocn": "Unreal Communications",
    "phone_number_configuration": {
      "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
      "tags": [
        "abc",
        "123"
      ]
    },
    "porting_phone_numbers_count": 1,
    "record_type": "porting_order",
    "requirements": [
      {
        "field_type": "document",
        "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
        "record_type": "porting_requirement",
        "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
      }
    ],
    "status": {
      "details": [
        {
          "code": "ENTITY_NAME_MISMATCH",
          "description": "Entity name does not match that on the CSR"
        }
      ],
      "value": "ported"
    },
    "support_key": "123abc",
    "updated_at": "2021-03-19T10:07:15.527Z",
    "user_feedback": {
      "user_comment": "I loved my experience porting numbers with Telnyx",
      "user_rating": 5
    },
    "user_reference": "Acct 123abc",
    "webhook_url": "https://example.com/porting_webhooks"
  },
  "meta": {
    "phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
  }
}

Cancel this porting ordercancelPortingOrder

post https://api.telnyx.com/v2/porting_orders/{id}/actions/cancel

Cancel this porting order

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{}' \
  https://api.telnyx.com/v2/porting_orders/{id}/actions/cancel
Parameters
In path
id
string (uuid)
required

Porting Order id

Responses
200

Successful response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": {
    "activation_settings": {
      "activation_status": "Active",
      "fast_port_eligible": true,
      "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
      "foc_datetime_requested": "2021-03-19T10:07:15.527Z"
    },
    "created_at": "2021-03-19T10:07:15.527Z",
    "end_user": {
      "admin": {
        "account_number": "123abc",
        "auth_person_name": "Porter McPortersen II",
        "billing_phone_number": 13035551234,
        "business_identifier": "abc123",
        "entity_name": "Porter McPortersen",
        "pin_passcode": 1234,
        "tax_identifier": "1234abcd"
      },
      "location": {
        "administrative_area": "IL",
        "country_code": "US",
        "extended_address": "Suite 504",
        "locality": "Chicago",
        "postal_code": "60654",
        "premises": "Mill House",
        "street_address": "311 W. Superior St"
      }
    },
    "id": "f1486bae-f067-460c-ad43-73a92848f902",
    "misc": {
      "new_billing_phone_number": "string",
      "remaining_numbers_action": "disconnect",
      "type": "full"
    },
    "old_service_provider_ocn": "Unreal Communications",
    "phone_number_configuration": {
      "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
      "tags": [
        "abc",
        "123"
      ]
    },
    "porting_phone_numbers_count": 1,
    "record_type": "porting_order",
    "requirements": [
      {
        "field_type": "document",
        "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
        "record_type": "porting_requirement",
        "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
      }
    ],
    "status": {
      "details": [
        {
          "code": "ENTITY_NAME_MISMATCH",
          "description": "Entity name does not match that on the CSR"
        }
      ],
      "value": "ported"
    },
    "support_key": "123abc",
    "updated_at": "2021-03-19T10:07:15.527Z",
    "user_feedback": {
      "user_comment": "I loved my experience porting numbers with Telnyx",
      "user_rating": 5
    },
    "user_reference": "Acct 123abc",
    "webhook_url": "https://example.com/porting_webhooks"
  },
  "meta": {
    "phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
  }
}

List all the allowed foc windowslistAllowedFocWindows

get https://api.telnyx.com/v2/porting_orders/{id}/allowed_foc_windows

Returns a list of time windows that foc is allowed.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/porting_orders/{id}/allowed_foc_windows"
Parameters
In path
id
string (uuid)
required

Porting Order id

Responses
200

Successful response

401

Unauthorized

Success Response
{
  "data": [
    {
      "ended_at": "2021-03-19T10:07:15.527Z",
      "record_type": "porting_order",
      "started_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

List all porting phone numberslistPortingPhoneNumbers

get https://api.telnyx.com/v2/porting_phone_numbers

Returns a list of your porting phone numbers.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/porting_phone_numbers?page[number]=1&page[size]=20"
Parameters
In query
page[number]
integer (1)
optional

The page number to load.

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page.

Default: 20
filter[porting_order_id]
string (uuid)
optional

Filter results by porting order id

filter[phone_number]
string
optional

Filter results by phone number

filter[activation_status]
string
optional

Activation status

Example: "Active"
Options: [ "New", "Pending", "Conflict", "Cancel Pending", "Failed", "Concurred", "Activate RDY", "Disconnect Pending", "Concurrence Sent", "Old", "Sending", "Active", "Canceled" ]
filter[portability_status]
string
optional

Specifies whether Telnyx is able to confirm portability this number in the United States & Canada. International phone numbers are provisional by default.

Example: "confirmed"
Options: [ "pending", "confirmed", "provisional" ]
Responses
200

Successful response

401

Unauthorized

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "data": [
    {
      "activation_status": "Active",
      "phone_number": 13035550987,
      "portability_status": "confirmed",
      "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "record_type": "porting_phone_number"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Was this section helpful?