List all extensions

This action will return a list of all extensions configured in the given unit.

Headers

`X-Auth-App`
`X-Auth-Token`
`X-Auth-Secret`
`X-Auth-Extension`
`X-Auth-Password`
`X-Proxy-Auth-Token`
`X-Proxy-Auth-Secret`

Parameters

`unit_id`	Integer
`sort_field`	String
`order`	String

Structures

Include extended attributes?	Yes - include extended attributes
Include expansions?	outbound_number voicemail_box pickup_group noanswer_destination unit status

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/extensions/list

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter	Type	Default
unit_id The ID of the unit	Integer	null
sort_field The field to order extensions by	String	name
order The order to return the extensions	String	ASC

Parameter

Type

Default

unit_id

The ID of the unit

Integer

null

sort_field

The field to order extensions by

String

name

order

The order to return the extensions

String

ASC

Errors

Error	Attributes
UnitNotFound The given unit was not found	id The provided ID

Error

Attributes

UnitNotFound

The given unit was not found

id

The provided ID

Response Data

This action will return an array of extension structures.

You'll receive all extended data with this structure, by default. You can change this behaviour by passing true or false in the _full parameter on the request. By default, you'll receive all expansions for the structure. You remove any/all of them by providing an array of new expansion names in the _expansions parameter on the request.