Skip to main content

List available phone numbers

GET 
/available_phone_numbers

List available phone numbers

Request

Query Parameters

    filter[phone_number][starts_with] string

    Filter numbers starting with a pattern (excludes NDC if used with national_destination_code filter).

    Examples:
    filter[phone_number][ends_with] string

    Filter numbers ending with a pattern (excludes NDC if used with national_destination_code filter).

    Examples:
    filter[phone_number][contains] string

    Filter numbers containing a pattern (excludes NDC if used with national_destination_code filter).

    Examples:
    filter[locality] string

    Filter phone numbers by city.

    Examples:
    filter[administrative_area] string

    Find numbers in a particular US state or CA province.

    Examples:
    filter[country_code] string

    Filter phone numbers by country.

    Examples:
    filter[national_destination_code] string

    Filter by the national destination code of the number.

    Examples:
    filter[rate_center] string

    Filter phone numbers by rate center. This filter is only applicable to USA and Canada numbers.

    Examples:
    filter[phone_number_type] string

    Possible values: [local, toll_free, mobile, national, shared_cost]

    Filter phone numbers by number type.

    filter[features] string[]

    Possible values: [sms, mms, voice, fax, emergency, hd_voice, international_sms, local_calling]

    Filter phone numbers with specific features.

    Examples:
    filter[limit] integer

    Limits the number of results.

    Examples:
    filter[best_effort] boolean

    Filter to determine if best effort results should be included. Only available in USA/CANADA.

    Examples:
    filter[quickship] boolean

    Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers.

    Examples:
    filter[reservable] boolean

    Filter to ensure only numbers that can be reserved are included in the results.

    Examples:
    filter[exclude_held_numbers] boolean

    Filter to exclude phone numbers that are currently on hold/reserved for your account.

    Examples:

Responses

200: Successful response with a list of available phone numbers.

default: Unexpected error

Loading...