List Account Phone Numbers

This endpoint returns a list of all phone numbers currently on your Flowroute account.

Endpoint

GET /numbers

Request Parameters

  • starts_with
    integer

    Displays a list of phone numbers that starts with your search value.

  • contains
    integer

    Displays a list of phone numbers that contains your search value.

  • ends_with
    inteer

    Displays a list of phone numbers that ends with your search value.

  • limit
    integer

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

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

Response Fields

  • alias - Friendly name for the phone number.

  • cnam_lookups_enabled - Boolean indicating whether CNAM (caller-ID name) Lookup is enabled for the phone number. To learn about setting this up, please see Set an Outbound Caller ID Name (CNAM Storage).

  • 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?offset=2 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?offset=2 -u accessKey:secretKey

Example Response

200 OK

{
  "data": [
    {
      "attributes": {
        "alias": null,
        "cnam_lookups_enabled": false,
        "number_type": "standard",
        "rate_center": "seattle",
        "state": "wa",
        "value": "1206462234"
      },
      "id": "12064621234",
      "links": {
        "self": "https://api.flowroute.com/v2.1/numbers/12064621234"
      },
      "type": "number"
    },
    {
      "attributes": {
        "alias": null,
        "cnam_lookups_enabled": true,
        "number_type": "standard",
        "rate_center": "nwyrcyzn07",
        "state": "ny",
        "value": "13473256789"
      },
      "id": "13473256789",
      "links": {
        "self": "https://api.flowroute.com/v2.1/numbers/13473256789"
      },
      "type": "number"
    }
  ],
  "links": {
    "prev": "https://api.flowroute.com/v2.1/numbers?limit=10&offset=0",
    "self": "https://api.flowroute.com/v2.1/numbers?limit=10&offset=2"
  }
}