{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/accounts/:account_id/phone-numbers","auth":"required","settings":"","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/phone-numbers');","language":"php"}]},"method":"get","params":[{"name":"account_id","type":"int","default":"","desc":"Account ID","required":false,"in":"path","ref":"","_id":"56fae76b4787442b008db3c0"},{"name":"filters[id]","type":"array_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":"573a41f6429789320071383e"},{"name":"filters[name]","type":"array_string","default":"","desc":"Name filter","required":false,"in":"query","ref":"","_id":"573a41f6429789320071383d"},{"name":"filters[phone_number]","type":"array_string","default":"","desc":"Phone number filter","required":false,"in":"query","ref":"","_id":"573a41f6429789320071383c"},{"name":"sort[id]","type":"string","default":"","desc":"ID sorting","required":false,"in":"query","ref":"","_id":"573a41f6429789320071383b"},{"name":"sort[name]","type":"string","default":"","desc":"Name sorting","required":false,"in":"query","ref":"","_id":"573a41f6429789320071383a"},{"name":"sort[phone_number]","type":"string","default":"","desc":"Phone number sorting","required":false,"in":"query","ref":"","_id":"573a41f64297893200713839"},{"name":"offset","type":"int","default":"","desc":"Max results","required":false,"in":"query","ref":"","_id":"573a41f64297893200713838"},{"name":"limit","type":"int","default":"","desc":"Results to skip","required":false,"in":"query","ref":"","_id":"573a41f64297893200713837"},{"name":"fields","type":"string","default":"all","desc":"Field set","required":false,"in":"query","ref":"","_id":"573c6c5bee2b3b2200422b6f"}],"results":{"codes":[{"status":200,"name":"","code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"id\": \"desc\"\n    },\n    \"total\": 3,\n    \"offset\": 0,\n    \"limit\": 10,\n    \"items\": [\n        {\n            \"id\": 38,\n            \"name\": \"Bobby\",\n            \"phone_number\": \"+15303616862\",\n            \"block_incoming\": true,\n            \"block_anonymous\": false,\n            \"ready_for_use\": false,\n            \"temporary_number\": \"+12532145678\",\n            \"route\": {\n                \"id\": 3,\n                \"name\": \"Customer Service tree\"\n            },\n            \"caller_id\": {\n                \"name\": \"Ryker\",\n                \"type\": \"personal\"\n            },\n            \"sms_forwarding\": {\n                \"type\": \"extension\",\n                \"extension\": {\n                    \"id\": 36,\n                    \"name\": \"Snufflupagus\",\n                    \"extension\": 987\n                }\n            },\n            \"call_notifications\": {\n                \"emails\": [\n                    \"test:::at:::test.com\"\n                ],\n                \"sms\": \"+18587740001\"\n            }\n        },\n        {\n            \"id\": 2,\n            \"name\": \"My other num\",\n            \"phone_number\": \"+19094438510\",\n            \"block_incoming\": false,\n            \"block_anonymous\": false,\n            \"ready_for_use\": true,\n            \"temporary_number\": null,\n            \"route\": null,\n            \"caller_id\": null,\n            \"sms_forwarding\": null,\n            \"call_notifications\": null\n        },\n        {\n            \"id\": 1,\n            \"name\": \"Tech Help Desk\",\n            \"number\": \"+13168493322\",\n            \"block_incoming\": false,\n            \"block_anonymous\": true,\n            \"ready_for_use\": true,\n            \"temporary_number\": null,       \n            \"route\": {\n                \"id\": 3,\n                \"name\": \"Tech Support\"\n            },\n            \"caller_id\": null,\n            \"sms_forwarding\": null,\n            \"call_notifications\": null\n        }\n    ]\n}","language":"json"}]}},"next":{"description":"","pages":[]},"title":"List Phone Numbers","type":"endpoint","slug":"list-account-phone-numbers","excerpt":"Get a list of phone numbers registered to an account. See [Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.","body":"See [Intro to Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57624356653c2d2200fec7e2","createdAt":"2016-05-16T23:04:54.200Z","editedParams2":true,"project":"55c8cff571d7580d0063a5e5","__v":2,"editedParams":true,"githubsync":"","parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Account Phone Numbers","slug":"account-numbers","order":22,"from_sync":false,"reference":true,"_id":"57624356653c2d2200fec7a6","__v":0,"project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","createdAt":"2016-03-29T05:00:50.119Z"},"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"},"user":"55c8cf9471d7580d0063a5e4"}

getList Phone Numbers

Get a list of phone numbers registered to an account. See [Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.

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[name]:
array of strings
Name filter
filters[phone_number]:
array of strings
Phone number filter
sort[id]:
string
ID sorting
sort[name]:
string
Name sorting
sort[phone_number]:
string
Phone number sorting
offset:
integer
Max results
limit:
integer
Results to skip
fields:
stringall
Field set

Examples


Result Format


Documentation

See [Intro to Account Phone Numbers](doc:account-phone-numbers) for more info on the properties.

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 }}