Search for Purchasable Phone Numbers

This endpoint lets you search for phone numbers by state or rate center, or by your specified search value.

Endpoint

GET /numbers/available

Request Parameters

  • limit
    integer

    Limits the number of items to retrieve. A maximum of 200 items can be retrieved.

  • starts_with
    integer

    Filters search results by phone numbers that start with your search value.

  • contains
    integer

    Filters search results by phone numbers that contain your search value.

  • ends_with
    inteer

    Filters search results by phone numbers that end with your search value.

  • offset
    integer

    Offsets the list of phone numbers by your specified value. For example, if you have 4 phone numbers and you entered 1 as your offset value, then only 3 of your phone numbers will be displayed in the response.

  • rate_center
    string

    Filters search results by phone numbers in the specified rate center.

  • state
    string

    Filters search results by phone numbers in the specified state. Optional unless a ratecenter is specified.

Response Fields

  • monthly_cost - Recurring monthly charge for the phone number.

  • setup_cost - Initial one-time setup cost for the purchasable phone number.

  • number_type - Phone number type. Defaults to "standard". Other possible values are "longcode" and "toll-free".

  • rate_center - The rate center associated with the NPANXX.

  • state - The US state or Canadian province or territory in which the NPANXX is located.

  • value - Value of the retrieved phone number.

Example Request

GET /v2.1/numbers/available HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Example Request

curl -X GET https://api.flowroute.com/v2.1/numbers/available -u accessKey:secretKey

Example Response

200 OK

{
  "data": [
    {
      "attributes": {
        "monthly_cost": 1.25,
        "number_type": "standard",
        "rate_center": "oradell",
        "setup_cost": 1.0,
        "state": "nj",
        "value": "12012675678"
      },
      "id": "12012675678",
      "links": {
        "related": "https://api.flowroute.com/v2.1/numbers/12012675678"
      },
      "type": "number"
    },
    {
      "attributes": {
        "monthly_cost": 1.25,
        "number_type": "standard",
        "rate_center": "oradell",
        "setup_cost": 1.0,
        "state": "nj",
        "value": "12012671234"
      },
      "id": "12012671234",
      "links": {
        "related": "https://api.flowroute.com/v2.1/numbers/12012671234"
      },
      "type": "number"
    }
  ],
  "links": {
    "next": "https://api.flowroute.com/v2.1/numbers/available?limit=2&offset=2",
    "self": "https://api.flowroute.com/v2.1/numbers/available?limit=2&offset=0"
  }
}