{"_id":"5797d665209a6e0e00b8325a","project":"55c8cff571d7580d0063a5e5","parentDoc":null,"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"},"__v":3,"githubsync":"","user":"571fcfeea0acd42000af95be","category":{"_id":"5797d3ab17ced017003c4be4","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-07-26T21:18:35.003Z","from_sync":false,"order":27,"slug":"account-subaccounts","title":"Account Subaccounts"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-26T21:30:13.184Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"<?php\n\nrequire '../vendor/autoload.php';\n\nuse GuzzleHttp\\Client;\n\n$token = \"YourToken\";\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n$response = $client->get('accounts/1/subaccounts');\n\necho $response->getBody();","language":"php","name":"PHP"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"id\": \"desc\"\n    },\n    \"total\": 1,\n    \"offset\": 0,\n    \"limit\": 10,\n    \"items\": [\n        {\n            \"id\": 123,\n            \"name\": \"Teddy\",\n            \"master_account\": {\n                \"id\": 1,\n                \"name\": \"Bobby Smith\",\n            },\n            \"contact\": {\n                \"name\": \"Teddy\",\n                \"company\": \"Acme, Inc.\",\n                \"address\": {\n                    \"line_1\": \"14282 Danielson Street\",\n                    \"line_2\": \"box 2\",\n                    \"city\": \"Poway\",\n                    \"province\": \"CA\",\n                    \"postal_code\": \"92064\",\n                    \"country\": \"US\"\n                },\n                \"phone\": \"+18585551111\",\n                \"fax\": \"+18585552222\",\n                \"primary_email\": \"test:::at:::phone.com\",\n                \"alternate_email\": \"test@gmail.com\"\n            },\n            \"billing_contact\": {\n                \"name\": \"Bobby\",\n                \"company\": \"xyz co\",\n                \"address\": {\n                    \"line_1\": \"100 Main St\",\n                    \"line_2\": \"#4\",\n                    \"city\": \"San Diego\",\n                    \"province\": \"CA\",\n                    \"postal_code\": \"92129\",\n                    \"country\": \"US\"\n                },\n                \"phone\": \"+18585553333\",\n                \"fax\": \"+18585554444\",\n                \"primary_email\": \"sample@phone.com\",\n                \"alternate_email\": \"sample@gmail.com\"\n            }\n        }\n    ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"57c5abc774d1052200eb5519","ref":"","in":"path","required":true,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"56f9bc2a97c8c10e0022104e","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":"56f9bc2a97c8c10e0022104d","ref":"","in":"query","required":false,"desc":"ID sorting","default":"","type":"string","name":"sort[id]"},{"_id":"56f9bc2a97c8c10e0022104c","ref":"","in":"query","required":false,"desc":"Max results","default":"","type":"int","name":"limit"},{"_id":"56f9bc2a97c8c10e0022104b","ref":"","in":"query","required":false,"desc":"Results to skip","default":"","type":"int","name":"offset"},{"_id":"573c6bcfee2b3b2200422b69","ref":"","in":"query","required":false,"desc":"Field set","default":"all","type":"string","name":"fields"}],"url":"/accounts/:account_id/subaccounts"},"isReference":true,"order":1,"body":"This service lists the [Subaccount](doc:subaccounts) of the authenticated client.  In most cases, there will not be any.","excerpt":"Get a list of subaccounts for the authenticated user or client","slug":"list-account-subaccounts","type":"endpoint","title":"List Subaccounts"}

getList Subaccounts

Get a list of subaccounts for the authenticated user or client

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
required
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.
sort[id]:
string
ID sorting
limit:
integer
Max results
offset:
integer
Results to skip
fields:
stringall
Field set

Examples


Result Format


Documentation

This service lists the [Subaccount](doc:subaccounts) of the authenticated client. In most cases, there will not be any.

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