Get Subaccounts
In this code snippet you will see how to retrieve a list of subaccounts for the parent account.
Example
Ensure the following variables are set to your required values using any convenient method:
| Key | Description |
|---|---|
VONAGE_API_KEY | The API key of the parent account. |
VONAGE_API_SECRET | The API secret of the parent account. |
Write the code
Add the following to get-subaccounts.sh:
curl "https://api.nexmo.com/accounts/$VONAGE_API_KEY/subaccounts" -u $VONAGE_API_KEY:$VONAGE_API_SECRETRun your code
Save this file to your machine and run it:
Prerequisites
npm install @vonage/subaccountsCreate a file named get-subaccounts.js and add the following code:
const { SubAccounts } = require('@vonage/subaccounts');
const subAccountClient = new SubAccounts({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET,
});Write the code
Add the following to get-subaccounts.js:
subAccountClient.getSubAccounts()
.then((subAccounts) => console.log(subAccounts))
.catch((error) => console.error(error));Run your code
Save this file to your machine and run it:
Prerequisites
Add the following to build.gradle:
Create a class named ListSubaccounts and add the following code to the main method:
Run your code
We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.subaccounts with the package containing ListSubaccounts:
Prerequisites
Add the following to build.gradle:
Create a class named ListSubaccounts and add the following code to the main method:
VonageClient client = VonageClient.builder()
.apiKey(VONAGE_API_KEY)
.apiSecret(VONAGE_API_SECRET)
.build();Write the code
Add the following to the main method of the ListSubaccounts class:
ListSubaccountsResponse response = client.getSubaccountsClient().listSubaccounts();Run your code
We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:
Run the following gradle command to execute your application, replacing com.vonage.quickstart.subaccounts with the package containing ListSubaccounts:
Prerequisites
Install-Package VonageCreate a file named GetSubAccountsRequest.cs and add the following code:
Add the following to GetSubAccountsRequest.cs:
Prerequisites
composer require vonage/clientCreate a file named get-subaccounts.php and add the following code:
Run your code
Save this file to your machine and run it:
Prerequisites
pip install vonage python-dotenvRun your code
Save this file to your machine and run it:
Prerequisites
gem install vonageCreate a file named list-subaccounts.rb and add the following code:
Write the code
Add the following to list-subaccounts.rb:
response = client.subaccounts.listRun your code
Save this file to your machine and run it:
Try it out
When you run the code you will retrieve a list of subaccounts.