---
title: "Slim List phone numbers"
method: GET
path: "/phone_numbers/slim"
tags: ["Phone Number Configurations"]
---

# 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.

## Query parameters

- `page` object
  - `number` integer — The page number to load
  - `size` integer — The size of the page
- `include_connection` boolean
- `include_tags` boolean
- `sort` 'purchased_at' | 'phone_number' | 'connection_name' | 'usage_payment_method'
- `filter` object
  - `billing_group_id` string — 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'.
  - `connection_id` string — Filter by connection_id.
  - `country_iso_alpha2` union — Filter by phone number country ISO alpha-2 code. Can be a single value or an array of values.
    - string
    - string[]
  - `customer_reference` string — Filter numbers via the customer_reference set.
  - `emergency_address_id` string — 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'.
  - `number_type` object — Filter phone numbers by phone number type.
    - `eq` 'local' | 'national' | 'toll_free' | 'mobile' | 'shared_cost' — Filter phone numbers by phone number type.
  - `phone_number` string — Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.
  - `source` 'ported' | 'purchased' — Filter phone numbers by their source. Use 'ported' for numbers ported from other carriers, or 'purchased' for numbers bought directly from Telnyx.
  - `status` 'purchase-pending' | 'purchase-failed' | 'port_pending' | 'active' | 'deleted' | 'port-failed' | 'emergency-only' | 'ported-out' | 'port-out-pending' — Filter by phone number status.
  - `tag` string — Filter by phone number tags. (This requires the include_tags param)
  - `voice.connection_name` object — Filter by voice connection name pattern matching (requires include_connection param).
    - `contains` string — Filter contains connection name. Requires at least three characters and the include_connection param.
    - `ends_with` string — Filter ends with connection name. Requires at least three characters and the include_connection param.
    - `eq` string — Filter by connection name.
    - `starts_with` string — Filter starts with connection name. Requires at least three characters and the include_connection param.
  - `voice.usage_payment_method` 'pay-per-minute' | 'channel' — Filter by usage_payment_method.

## Response `200`

Successful response with a list of phone numbers.

- object
  - `data` NumbersSlimPhoneNumberDetailed[]
    - `activated_at` string, date-time, nullable — ISO 8601 formatted date indicating when the phone number was first activated (transitioned from purchase-pending or port-pending to active). Will be null for numbers that have not yet been activated, or for legacy numbers activated before this field was tracked.
    - `billing_group_id` string — Identifies the billing group associated with the phone number.
    - `call_forwarding_enabled` boolean — Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.
    - `call_recording_enabled` boolean — Indicates whether call recording is enabled for this number.
    - `caller_id_name_enabled` boolean — Indicates whether caller ID is enabled for this number.
    - `cnam_listing_enabled` boolean — Indicates whether a CNAM listing is enabled for this number.
    - `connection_id` string — Identifies the connection associated with the phone number.
    - `country_iso_alpha2` string — The ISO 3166-1 alpha-2 country code of the phone number.
    - `created_at` string — ISO 8601 formatted date indicating when the resource was created.
    - `customer_reference` string — A customer reference string for customer look ups.
    - `emergency_address_id` string — Identifies the emergency address associated with the phone number.
    - `emergency_enabled` boolean — Indicates whether emergency services are enabled for this number.
    - `emergency_status` 'active' | 'deprovisioning' | 'disabled' | 'provisioning' | 'provisioning-failed' — Indicates the status of the provisioning of emergency services for the phone number. This field contains information about activity that may be ongoing for a number where it either is being provisioned or deprovisioned but is not yet enabled/disabled.
    - `external_pin` string — If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.
    - `hd_voice_enabled` boolean — Indicates whether HD voice is enabled for this number.
    - `id` string — Identifies the resource.
    - `inbound_call_screening` 'disabled' | 'reject_calls' | 'flag_calls' — The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it.
    - `phone_number` string — The +E.164-formatted phone number associated with this record.
    - `phone_number_type` 'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost' | 'landline' | 'tollfree' | 'shortcode' | 'longcode' — The phone number's type. Note: For numbers purchased prior to July 2023 or when fetching a number's details immediately after a purchase completes, the legacy values `tollfree`, `shortcode` or `longcode` may be returned instead.
    - `purchased_at` string — ISO 8601 formatted date indicating when the resource was purchased.
    - `record_type` string — Identifies the type of the resource.
    - `status` 'purchase-pending' | 'purchase-failed' | 'port-pending' | 'port-failed' | 'active' | 'deleted' | 'emergency-only' | 'ported-out' | 'port-out-pending' | 'requirement-info-pending' | 'requirement-info-under-review' | 'requirement-info-exception' | 'provision-pending' — The phone number's current status.
    - `t38_fax_gateway_enabled` boolean — Indicates whether T38 Fax Gateway for inbound calls to this number.
    - `updated_at` string — ISO 8601 formatted date indicating when the resource was updated.
  - `meta` PaginationMeta
    - `page_number` integer
    - `page_size` integer
    - `total_pages` integer
    - `total_results` integer

## Other responses

- `400` — Bad request, the request was unacceptable, often due to missing a required parameter.
- `401` — Unauthorized
- `404` — The requested resource doesn't exist.
- `422` — Unprocessable entity. Check the 'detail' field in response for details.
- `500` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/revisions/ec31f78cf002/schema)