{"_id":"57624356653c2d2200fec7db","version":{"_id":"57624356653c2d2200fec79c","__v":20,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"57624356653c2d2200fec7a8","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-27T14:03:08.031Z","from_sync":false,"order":23,"slug":"routes","title":"Account Routes"},"editedParams2":true,"parentDoc":null,"__v":1,"editedParams":true,"user":"55c8cf9471d7580d0063a5e4","project":"55c8cff571d7580d0063a5e5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T22:47:42.494Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"id\": \"desc\"\n    },\n    \"total\": 2,\n    \"offset\": 0,\n    \"limit\": 10,\n    \"items\": [\n        {\n            \"id\": 98357,\n            \"name\": \"Go to main menu\",\n            \"rules\": [\n                {\n                    \"actions\": [\n                        {\n                            \"action\": \"menu\",\n                            \"menu\": {\n                                \"id\": 37052,\n                                \"name\": \"Main Menu\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        },\n        {\n            \"id\": 7781,\n            \"name\": \"Bob's voicemail\",\n            \"extension\": {\n                \"id\": 82351,\n                \"extension\": 504,\n                \"name\": \"Bob's Desk\"\n            },\n            \"rules\": [\n                {\n                    \"actions\": [\n                        {\n                            \"action\": \"forward\",\n                            \"items\": [\n                                {\n                                    \"type\": \"phone_number\",\n                                    \"number\": \"+13334445555\",\n                                    \"screening\": false,\n                                    \"caller_id\": \"calling_number\",\n                                    \"voice_tag\": \"Bob Martin\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}","language":"json","status":200,"name":""}]},"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/routes');","language":"php"}]},"auth":"required","params":[{"_id":"56fae76b4787442b008db3c0","ref":"","in":"path","required":false,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"573a3fdb17422532001d3451","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":"573a3fdb17422532001d3450","ref":"","in":"query","required":false,"desc":"Name filter","default":"","type":"array_string","name":"filters[name]"},{"_id":"573a3fdb17422532001d344f","ref":"","in":"query","required":false,"desc":"ID sorting","default":"","type":"string","name":"sort[id]"},{"_id":"573a3fdb17422532001d344e","ref":"","in":"query","required":false,"desc":"Name sorting","default":"","type":"string","name":"sort[name]"},{"_id":"573a43b07f35072900c8512d","ref":"","in":"query","required":false,"desc":"Max results","default":"","type":"int","name":"limit"},{"_id":"573a43b07f35072900c8512c","ref":"","in":"query","required":false,"desc":"Results to skip","default":"","type":"int","name":"offset"},{"_id":"573c6c74ee2b3b2200422b70","ref":"","in":"query","required":false,"desc":"Field set","default":"all","type":"string","name":"fields"}],"url":"/accounts/:account_id/routes"},"isReference":true,"order":1,"body":"","excerpt":"Get a list of routes for an account.  See [Intro to Routes](doc:account-routes) for more info on the properties.","slug":"list-account-routes","type":"endpoint","title":"List Routes"}

getList Routes

Get a list of routes for an account. See [Intro to Routes](doc:account-routes) 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
sort[id]:
string
ID 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 }}