List Available Tiers

Returns a list of Tiers containing purchasable phone numbers. All request parameters are optional.

Endpoint

GET /available/tiers

Query Parameters

  • limit
    integer

    Limits the number of tiers to retrieve. A maximum of 200 items can be retrieved with 10 being the default value if not specified.

  • offset
    integer

    Offsets the list of tiers to retrieve by your specified value.

Response Fields

On success, the HTTP status code in the response header is 200 OK and the response body contains an array of tier objects in JSON format. On error, the header status code is an error code and the response body contains an array of error objects.

  • data
    array

    An array of tier objects that satisfy your query individually composed of:

    • id
      string

      Human Readable Tier identifier

    • links
      object

      Links object pointing to the related array of phone numbers that are associated with the Tier. The tier identifier is URL encoded with $ as %24, space as %20, and / as %2F.

    • type
      string

      This will always be tier.

  • links
    object

    Links object pointing to your search and a link to the next page if any. For example, https://api.flowroute.com/v2/numbers/available/tiers?limit=2&offset=0.

Example Request

GET /v2/numbers/available/tiers?limit=2 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Example Request

curl https://api.flowroute.com/v2/numbers/available/tiers?limit=2 -u accessKey:secretKey

Example Responses

200 OK

{
  {
    "data": [
      {
        "id": "Standard",
        "links": {
          "related": "https://api.flowroute.com/v2/numbers?tier=Standard"
        },
        "type": "tier"
      },
      {
        "id": "US Promo $0.0/$0.50/$0.005",
        "links": {
          "related": "https://api.flowroute.com/v2/numbers?tier=US%20Promo%20%240.0%2F%240.50%2F%240.005"
        },
        "type": "tier"
      }
    ],
    "links": {
      "next": "https://api.flowroute.com/v2/numbers/tiers?limit=2&offset=2",
      "self": "https://api.flowroute.com/v2/numbers/tiers?limit=2&offset=0"
    }
  }