{"_id":"57624356653c2d2200fec7b6","parentDoc":null,"githubsync":"","__v":3,"category":{"_id":"57624356653c2d2200fec7a0","__v":0,"version":"57624356653c2d2200fec79c","project":"55c8cff571d7580d0063a5e5","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-28T23:43:07.914Z","from_sync":false,"order":12,"slug":"extensions","title":"Account Extensions"},"editedParams":true,"user":"55c8cf9471d7580d0063a5e4","editedParams2":true,"project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":22,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T13:26:10.541Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"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');","language":"php"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"extension\": \"asc\"\n    },\n    \"total\": 2,\n    \"offset\": 0,\n    \"limit\": 10,\n    \"items\": [\n        {\n            \"id\": 113,\n            \"usage_type\": \"unlimited\",\n            \"extension\": 60,\n            \"name\": \"Jane's Desk\",\n            \"full_name\": \"Jane Lee\",\n            \"timezone\": \"America/Los_Angeles\",\n            \"name_greeting\": {\n                \"id\": 2984,\n                \"name\": \"Jane Lee\"\n            },\n            \"include_in_directory\": false,\n            \"caller_id\": \"+13168493322\",\n            \"local_area_code\": \"858\",\n            \"enable_call_waiting\": true,\n            \"enable_outbound_calls\": true,\n            \"voicemail\": {\n                \"enabled\": true,\n                \"password\": \"1231\",\n                \"greeting\": {\n                    \"type\": \"standard\",\n                    \"alternate\": {\n                        \"id\": 2984,\n                        \"name\": \"Holiday office hours\"\n                    },\n                    \"standard\": {\n                        \"id\": 462,\n                        \"name\": \"Jane's desk\"\n                    },\n                    \"enable_leave_message_prompt\": true\n                },\n                \"attachments\": \"mp3\",\n                \"notifications\": {\n                    \"emails\": [\n                        \"ggggg:::at:::rr.com\",\n                        \"test@adsadaf.com\"\n                    ],\n                    \"sms\": \"+18587741111\"\n                },\n                \"transcription\": \"automated\"\n            },\n            \"call_notifications\": {\n                \"emails\": [\n                    \"jlee@work.com\"\n                ],\n                \"sms\": \"+12223334444\"\n            },\n            \"device_membership\": null\n        }, \n        {\n            \"id\": 126,\n            \"usage_type\": \"limited\",\n            \"extension\": 71,\n            \"name\": \"Fred\",\n            \"full_name\": \"Fred Brown\",\n            \"timezone\": \"America/New_York\",\n            \"name_greeting\": null,\n            \"include_in_directory\": false,\n            \"caller_id\": \"+13168493322\",\n            \"local_area_code\": \"316\",\n            \"enable_call_waiting\": true,\n            \"enable_outbound_calls\": false,          \n            \"voicemail\": {\n                \"enabled\": true,\n                \"password\": \"1231\",\n                \"greeting\": {\n                    \"type\": \"name\",\n                    \"alternate\": null,\n                    \"standard\": null,\n                    \"enable_leave_message_prompt\": true\n                },\n                \"notifications\": null,\n                \"transcription\": \"automated\"\n            },\n            \"call_notifications\": {\n                \"emails\": [\n                    \"fred@example.com\"\n                ],\n                \"sms\": \"+18587748888\"\n            },\n            \"device_membership\": null\n        }\n    ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"56f9c28a5e9c512200d91b53","ref":"","in":"path","required":false,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"56f9c28a5e9c512200d91b52","ref":"","in":"query","required":false,"desc":"ID filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.","default":"","type":"array_string","name":"filters[id]"},{"_id":"56fa05cf3130030e0081b9e5","ref":"","in":"query","required":false,"desc":"Extension filter","default":"","type":"array_string","name":"filters[extension]"},{"_id":"56fa05cf3130030e0081b9e4","ref":"","in":"query","required":false,"desc":"Name filter","default":"","type":"array_string","name":"filters[name]"},{"_id":"56f9c28a5e9c512200d91b51","ref":"","in":"query","required":false,"desc":"ID sorting","default":"","type":"string","name":"sort[id]"},{"_id":"56fa05cf3130030e0081b9e3","ref":"","in":"query","required":false,"desc":"Extension sorting","default":"","type":"string","name":"sort[extension]"},{"_id":"56fa05cf3130030e0081b9e2","ref":"","in":"query","required":false,"desc":"Name sorting","default":"","type":"string","name":"sort[name]"},{"_id":"56f9c28a5e9c512200d91b50","ref":"","in":"query","required":false,"desc":"Max results","default":"","type":"int","name":"limit"},{"_id":"56f9c28a5e9c512200d91b4f","ref":"","in":"query","required":false,"desc":"Results to skip","default":"","type":"int","name":"offset"},{"_id":"573c6bf9f09c292200b398a5","ref":"","in":"query","required":false,"desc":"Field set","default":"all","type":"string","name":"fields"}],"url":"/accounts/:account_id/extensions"},"isReference":true,"order":1,"body":"","excerpt":"Get a list of detailed extension information visible to the authenticated user or client. See [extension](doc:account-extensions) for more details.\n\nNOTE:  This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the List Extension API with the following definition:\n\n        GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/extensions\n\nFor security purpose, the Extension level API returns only the list of extension ID, name and number associated with the account.","slug":"list-account-extensions","type":"endpoint","title":"List Extensions"}

getList Extensions

Get a list of detailed extension information visible to the authenticated user or client. See [extension](doc:account-extensions) for more details. NOTE: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the List Extension API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/extensions For security purpose, the Extension level API returns only the list of extension ID, name and number associated with the account.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID

Query Params

filters[id]:
array of strings
ID filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.
filters[extension]:
array of strings
Extension filter
filters[name]:
array of strings
Name filter
sort[id]:
string
ID sorting
sort[extension]:
string
Extension sorting
sort[name]:
string
Name 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 }}