Extensions

List Extensions

Get a list of detailed extension information visible to the authenticated user or client.

get/v4/accounts/{voip_id}/extensions

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/extensions
  • 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[extension]string

Extension filter

filters[name]string

Name filter

filters[full_name]string

Full Name filter

filters[virtual]string

1 for virtual extensions; 0 for non-virtual extensions.

filters[has_real_route]string

1 for extensions with meaningful routes (not just 'disconnect') or attached to devices (non-virtual); 0 for other extensions.

filters[eligible_for_device]string

Eligibility to be used with device. 1 for extensions which can be used with device; 0 for extensions which can't.

filters[role]string

Extension role. Available values: 'device', 'virtual', 'company-inbox', 'nxt-user', 'common-area', 'app', 'softphone'

filters[nxt_extensions]string

Define generation of extensions to be returned. 1 for NXT extensions, 0 for classic extensions.

filters[name-or-extension]string

Name or Extension filter

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.