Skip to main content

Search for available Phone Numbers to Purchase

GET 
/phone_numbers/search

Returns a list of phone numbers available for purchase that match the given search criteria parameters.

Permissions​

The API token must include the following scopes: Numbers.

Request​

Query Parameters

    areacode string

    An areacode to search within.

    number_type string

    Search for either local or toll-free numbers. Defaults to local.

    starts_with string

    A string of 3 to 7 digits that should be used as the start of a number. Cannot be used in combination with contains or ends_with.

    contains string

    A string of 3 to 7 digits that should appear somewhere in the number. Cannot be used in combination with starts_with or ends_with.

    ends_with string

    A string of 3 to 7 digits that should be used as the end of a number. Cannot be used in combination with starts_with or contains.

    max_results number

    The maximum number of matches to return. Upper limit of 100. Defaults to 50.

    region string

    A region or state to search within. Must be an ISO 3166-2 alpha-2 code, i.e. TX for Texas. Cannot be used in combination with areacode.

    city string

    A specific City to search within. Must be used in combination with region. Cannot be used in combination with areacode, starts_with, contains, or ends_with.

Responses​

OK

Schema

    links

    object

    self string
    first string
    next string
    prev string
    data object[]
Loading...