{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/accounts/:account_id/extensions/:extension_id/contacts","auth":"required","examples":{"codes":[{"code":"<?php\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n$response = $client->get('accounts/123/extensions/456/contacts');","language":"php"}]},"method":"get","params":[{"name":"account_id","type":"int","default":"","desc":"Account ID","required":false,"in":"path","ref":"","_id":"56fac41752807c2000b77804"},{"name":"extension_id","type":"int","default":"","desc":"Extension ID","required":false,"in":"path","ref":"","_id":"56fac41752807c2000b77803"},{"name":"filters[id]","type":"string","default":"","desc":"ID filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.","required":false,"in":"query","ref":"","_id":"56fac41752807c2000b77802"},{"name":"filters[group_id]","type":"string","default":"","desc":"Group filter","required":false,"in":"query","ref":"","_id":"56fac41752807c2000b77801"},{"name":"filters[updated_at]","type":"string","default":"","desc":"Updated At filter","required":false,"in":"query","ref":"","_id":"56fac41752807c2000b77800"},{"name":"filters[name]","type":"string","default":"","desc":"Contact name = first name + middle name + last name","required":false,"in":"query","ref":"","_id":"5b19f640b3baf90003cac024"},{"name":"filters[phone]","type":"string","default":"","desc":"Phone Number","required":false,"in":"query","ref":"","_id":"5b19f640b3baf90003cac023"},{"name":"sort[id]","type":"string","default":"","desc":"ID sorting","required":false,"in":"query","ref":"","_id":"56fac41752807c2000b777ff"},{"name":"sort[updated_at]","type":"string","default":"","desc":"Updated At sorting","required":false,"in":"query","ref":"","_id":"56fac41752807c2000b777fe"},{"name":"limit","type":"int","default":"","desc":"Max results","required":false,"in":"query","ref":"","_id":"56fac41752807c2000b777fd"},{"name":"offset","type":"int","default":"","desc":"Results to skip","required":false,"in":"query","ref":"","_id":"56fac41752807c2000b777fc"},{"name":"fields","type":"string","default":"all","desc":"Field set","required":false,"in":"query","ref":"","_id":"573c6c129eef3a0e00b51bfa"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"id\": \"asc\"\n    },\n    \"total\": 2,\n    \"offset\": 0,\n    \"limit\": 10,\n    \"items\": [\n        {\n            \"id\": 4567352,\n            \"prefix\": \"Captain\",\n            \"first_name\": \"Jean-luc\",\n            \"middle_name\": \"\",\n            \"last_name\": \"Picard\",\n            \"phonetic_first_name\": \"\",\n            \"phonetic_middle_name\": \"\",\n            \"phonetic_last_name\": \"\",\n            \"suffix\": \"\",\n            \"nickname\": \"Captain Picard\",\n            \"company\": \"United Federation of Planets\",\n            \"department\": \"Starfleet\",\n            \"job_title\": \"Ship's Captain\",\n            \"created_at\": 1459248847,\n            \"updated_at\": 1459274344,\n            \"emails\": [\n                {\n                    \"type\": \"primary\",\n                    \"email\": \"jean-luc.picard:::at:::example.com\"\n                }\n            ],\n            \"phone_numbers\": [\n                {\n                    \"type\": \"business\",\n                    \"number\": \"(999) 999-9999\",\n                    \"normalized\": \"+19999999999\"\n                }\n            ],\n            \"addresses\": [\n                {\n                    \"type\": \"home\",\n                    \"street\": \"1212 Federation Way\",\n                    \"city\": \"San Francisco\",\n                    \"state\": \"CA\",\n                    \"zip\": \"99999\",\n                    \"country\": \"USA\"\n                }\n            ],\n            \"group\": {\n                \"id\": 982357,\n                \"name\": \"NCC 1701-D Bridge Crew\"\n            }\n        },\n        {\n            \"id\": 7235232,\n            \"prefix\": \"\",\n            \"first_name\": \"William\",\n            \"middle_name\": \"Thomas\",\n            \"last_name\": \"Riker\",\n            \"phonetic_first_name\": \"\",\n            \"phonetic_middle_name\": \"\",\n            \"phonetic_last_name\": \"\",\n            \"suffix\": \"\",\n            \"nickname\": \"Number One\",\n            \"company\": \"United Federation of Planets\",\n            \"department\": \"Starfleet\",\n            \"job_title\": \"First Officer\",\n            \"creaetd_at\": 1458819384,\n            \"updated_at\": 1458825342,\n            \"emails\": [\n                {\n                    \"type\": \"primary\",\n                    \"email\": \"[email protected]\"\n                }\n            ],\n            \"phone_numbers\": [],\n            \"addresses\": [],\n            \"group\": {\n                \"id\": 982357,\n                \"name\": \"NCC 1701-D Bridge Crew\"\n            }\n        }\n    ]\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"List Contacts","type":"endpoint","slug":"list-account-extension-contacts","excerpt":"Show a list of address book contacts.  See [Account Contacts](doc:account-extension-contacts) for more info on the fields in each item.","body":"","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57624356653c2d2200fec7c3","__v":2,"version":{"version":"4","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f","5ede526e75bc22005d0adecc"],"_id":"57624356653c2d2200fec79c","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","__v":23,"project":"55c8cff571d7580d0063a5e5"},"editedParams2":true,"project":"55c8cff571d7580d0063a5e5","parentDoc":null,"user":"55c8cf9471d7580d0063a5e4","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Account Extension Contacts","slug":"account-extension-contacts","order":14,"from_sync":false,"reference":true,"_id":"57624356653c2d2200fec7a2","__v":0,"version":"57624356653c2d2200fec79c","project":"55c8cff571d7580d0063a5e5","createdAt":"2016-03-29T04:52:14.767Z"},"createdAt":"2016-03-29T04:52:50.062Z","editedParams":true,"githubsync":""}

getList Contacts

Show a list of address book contacts. See [Account Contacts](doc:account-extension-contacts) for more info on the fields in each item.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID
extension_id:
integer
Extension ID

Query Params

filters[id]:
string
ID filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.
filters[group_id]:
string
Group filter
filters[updated_at]:
string
Updated At filter
filters[name]:
string
Contact name = first name + middle name + last name
filters[phone]:
string
Phone Number
sort[id]:
string
ID sorting
sort[updated_at]:
string
Updated At sorting
limit:
integer
Max results
offset:
integer
Results to skip
fields:
stringall
Field set

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}