GET /porting_orders

telnyx.com

Summary: List all porting orders
Operation ID: listPortingOrders
Auth: unknown
Description

Returns a list of your porting order.

Parameters (14)

filter[activation_settings][fast_port_eligible] (boolean, query, optional)

Filter results by fast port eligible

filter[activation_settings][foc_datetime_requested][gt] (string, query, optional)

Filter results by foc date later than this value

filter[activation_settings][foc_datetime_requested][lt] (string, query, optional)

Filter results by foc date earlier than this value

filter[customer_reference] (string, query, optional)

Filter results by user reference

filter[end_user][admin][auth_person_name] (string, query, optional)

Filter results by authorized person

filter[end_user][admin][entity_name] (string, query, optional)

Filter results by person or company name

filter[misc][type] (?, query, optional)

Filter results by porting order type

filter[phone_numbers][carrier_name] (string, query, optional)

Filter results by old service provider

filter[phone_numbers][country_code] (string, query, optional)

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

filter[status] (?, query, optional)

Filter results by status

include_phone_numbers (boolean, query, optional, default: True)

Include the first 50 phone number objects in the results

page[number] (integer, query, optional, default: 1)

The page number to load.

Constraints: {'minimum': 1}

page[size] (integer, query, optional, default: 20)

The size of the page.

Constraints: {'minimum': 1, 'maximum': 250}

sort (string, query, optional)

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

Constraints: {'enum': ['created_at', '-created_at', 'activation_settings.foc_datetime_requested', '-activation_settings.foc_datetime_requested']}

No probe data for this endpoint yet.