---
title: "List available phone numbers"
method: GET
path: "/available_phone_numbers"
tags: ["Phone Number Search"]
---

# List available phone numbers

`GET /available_phone_numbers`

## Query parameters

- `filter` object
  - `phone_number` object — Filter phone numbers by pattern matching.
    - `starts_with` string — Filter numbers starting with a pattern (excludes NDC if used with `national_destination_code` filter).
    - `ends_with` string — Filter numbers ending with a pattern (excludes NDC if used with `national_destination_code` filter).
    - `contains` string — Filter numbers containing a pattern (excludes NDC if used with `national_destination_code` filter).
  - `locality` string — Filter phone numbers by city.
  - `administrative_area` string — Find numbers in a particular US state or CA province.
  - `country_code` string — Filter phone numbers by country.
  - `national_destination_code` string — Filter by the national destination code of the number.
  - `rate_center` string — Filter phone numbers by rate center. This filter is only applicable to USA and Canada numbers.
  - `phone_number_type` 'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost' — Filter phone numbers by number type.
  - `features` string[] — Filter phone numbers with specific features.
  - `limit` integer — Limits the number of results.
  - `best_effort` boolean — Filter to determine if best effort results should be included. Only available in USA/CANADA.
  - `quickship` boolean — Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.
  - `reservable` boolean — Filter to ensure only numbers that can be reserved are included in the results.
  - `exclude_held_numbers` boolean — Filter to exclude phone numbers that are currently on hold/reserved for your account.

## Response `200`

Successful response with a list of available phone numbers.

- object
  - `data` AvailablePhoneNumber[]
    - `record_type` 'available_phone_number'
    - `phone_number` string
    - `vanity_format` string
    - `best_effort` boolean — Specifies whether the phone number is an exact match based on the search criteria or not.
    - `quickship` boolean — Specifies whether the phone number can receive calls immediately after purchase or not.
    - `reservable` boolean — Specifies whether the phone number can be reserved before purchase or not.
    - `region_information` RegionInformation[]
      - `region_type` 'country_code' | 'rate_center' | 'state' | 'location'
      - `region_name` string
    - `cost_information` CostInformation
      - `upfront_cost` string
      - `monthly_cost` string
      - `currency` string — The ISO 4217 code for the currency.
    - `features` Feature[]
      - `name` string
  - `meta` AvailablePhoneNumbersMetadata
    - `total_results` integer
    - `best_effort_results` integer
  - `metadata` AvailablePhoneNumbersMetadata
    - `total_results` integer
    - `best_effort_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/versions/8f5f4e537994/schema)