Routes

List Routes

Get a list of routes for an account

get/v4/accounts/{voip_id}/routes

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/routes
  • Auth: HTTP bearer

Path parameters

voip_idinteger required

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

sort[id]'asc' | 'desc'

Sort response

include_subaccountsinteger

Send "1" if you want to add subaccounts data into output

filters[name]string

Name filter

filters[extension]string

Extension

with_usageinteger

Add route usage into the output

mode'brief' | 'full'

Defines mode of the data output (brief or full)

Response

OK

filtersobject
sortobject
totalinteger
limitinteger
offsetinteger
itemsobject[]

Changes

No operation changes recorded.