Skip to main content

Slim List phone numbers

GET 
/phone_numbers/slim

List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.

Request

Query Parameters

    page object

    Consolidated page parameter (deepObject style). Originally: page[size], page[number]

    include_connection boolean

    Include the connection associated with the phone number.

    include_tags boolean

    Include the tags associated with the phone number.

    sort string

    Possible values: [purchased_at, phone_number, connection_name, usage_payment_method]

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

    filter object

    Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[phone_number], filter[status], filter[country_iso_alpha2], filter[connection_id], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference], filter[number_type], filter[source]

Responses

200: Successful response with a list of phone numbers.

default: Unexpected error

Request samples


curl -L 'https://api.telnyx.com/v2/phone_numbers/slim' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


{
"data": [
{
"id": "1293384261075731499",
"record_type": "phone_number",
"phone_number": "+19705555098",
"country_iso_alpha2": "US",
"status": "active",
"external_pin": "1234",
"connection_id": "1293384261075731499",
"customer_reference": "customer-reference",
"billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"emergency_enabled": true,
"emergency_address_id": "1315261609962112019",
"emergency_status": "active",
"call_forwarding_enabled": true,
"cnam_listing_enabled": true,
"caller_id_name_enabled": true,
"call_recording_enabled": true,
"t38_fax_gateway_enabled": true,
"phone_number_type": "local",
"inbound_call_screening": "disabled",
"purchased_at": "2019-10-23T18:10:00.000Z",
"created_at": "2019-10-23T18:10:00.000Z",
"updated_at": "2019-10-24T18:10:00.000Z",
"hd_voice_enabled": true
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}