GET phone_numbers

telnyx.com

Summary: List phone numbers
Operation ID: listPhoneNumbers
Auth: unknown

Parameters (14)

filter[billing_group_id] (string, query, optional)

Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.

filter[customer_reference] (string, query, optional)

Filter numbers via the customer_reference set.

filter[emergency_address_id] (string, query, optional)

Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.

filter[phone_number] (string, query, optional)

Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.

filter[status] (string, query, optional)

Filter by phone number status.

Constraints: {'enum': ['purchase_pending', 'purchase_failed', 'port_pending', 'active', 'deleted', 'port_failed', 'emergency_only', 'ported_out', 'port_out_pending']}

filter[tag] (string, query, optional)

Filter by phone number tags.

filter[usage_payment_method] (string, query, optional)

Filter by usage_payment_method.

Constraints: {'enum': ['pay-per-minute', 'channel']}

filter[voice.connection_name][contains] (string, query, optional)

Filter contains connection name. Requires at least three characters.

filter[voice.connection_name][ends_with] (string, query, optional)

Filter ends with connection name. Requires at least three characters.

filter[voice.connection_name][eq] (string, query, optional)

Filter by connection name.

filter[voice.connection_name][starts_with] (string, query, optional)

Filter starts with connection name. Requires at least three characters.

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': ['purchased_at', 'phone_number', 'connection_name', 'usage_payment_method']}

No probe data for this endpoint yet.