Extension Contacts

List Contacts

Show a list of address book contacts.

get/v4/accounts/{voip_id}/extensions/{extension_id}/contacts

Request

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

Path parameters

voip_idinteger required
extension_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

Contact name = first name + middle name + last name

filters[group_id]string

Group filter

filters[phone]string

Phone Number

filters[updated_at]string

Filters by update date

filters[include_trashed]string

only=deleted contacts; ignore=existing contacts; with=both deleted and existing contacts

filters[duplications]string

Use this filter to return contacts which have duplications. You can analyze them and resolve duplications the way you want on your side via other contacts endpoints. Possible values: intersection - any match (name, email or number) name - name is the same email - email is the same number - phone number is the same number-or-email - email and/or number is the same

filters[deleted_at]string

Filters by deletion date. Deleted records will be included automatically

filters[modified_at]string

Filters by update or deletion date. Deleted records are not included by default.

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.