GET /phone_numbers

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 numbers via the customer_reference set.

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 by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.

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 by phone number tags.

Filter by usage_payment_method.

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

Filter contains connection name. Requires at least three characters.

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

Filter by connection name.

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

The page number to load.

Constraints: {'minimum': 1}

The size of the page.

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

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']}