Latest Legacy

List all Subaccounts

Returns a list of subaccounts sorted by creation date, with the most recently created subaccount appearing first.

API Endpoint

GET https://api.vtscom.net/v1/Account/{auth_id}/Subaccount/

Arguments

limit integer

Denotes the number of results displayed per page. The maximum number of results that can be fetched is 20.

offset integer

Denotes the number of value items by which the results should be offset.

Returns

An array of Subaccount objects.

Response

HTTP Status Code: 200

{
  "api_id": "b38bf42e-0db4-11e4-8a4a-123140008edf",
  "meta": {
    "limit": 20,
    "next": null,
    "offset": 0,
    "previous": null,
    "total_count": 2
  },
  "objects": [{
      "account": "/v1/Account/MA2025RK4E639VJFZAGV/",
      "auth_id": "SA2025RK4E639VJFZAMM",
      "auth_token": "MTZjYWM0YzVjNjMwZmVmODFiNWJjNWJmOGJjZjgw",
      "created": "2022-07-17",
      "enabled": false,
      "modified": null,
      "name": "Chewbacca",
      "resource_uri": "/v1/Account/MA2025RK4E639VJFZAGV/Subaccount/SA2025RK4E639VJFZAMM/"
    },
    {
      "account": "/v1/Account/MA2025RK4E639VJFZAGV/",
      "auth_id": "SA1914RK4E639VJFZAMM",
      "auth_token": "OTdhMjYwMWYxOGMyNpFjNzUwYWM3YWI3NjY4Y2Ey",
      "created": "2022-09-23",
      "enabled": true,
      "modified": "2022-09-23",
      "name": "new",
      "resource_uri": "/v1/Account/MA2025RK4E639VJFZAGV/Subaccount/SA1914RK4E639VJFZAMM/"
    }
  ]
}

Example Request

1
2
3
4
5
6
7
import vts

client = vts.RestClient('<auth_id>','<auth_token>')
response = client.subaccounts.list(
    offset=0,
    limit=5, )
print(response)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#
# Example for Subaccount List
#
require 'rubygems'
require 'vts'

include vts
include vts::Exceptions

api = RestClient.new("<auth_id>","<auth_token>")

begin
  response = api.subaccounts.list(
    limit: 5,
    offset: 0,
  )
  puts response
rescue VTSRESTError => e
  puts 'Exception: ' + e.message
end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Example for Subaccount list

var vts = require('vts');

(function main() {
    'use strict';
    
   // If auth id and auth token are not specified, VTS will fetch them from the environment variables.
    var client = new vts.Client("<auth_id>","<auth_token>");
    client.subaccounts.list(
        {
            offset: 0,
            limit: 5,
        },
    ).then(function (response) {
        console.log(response);
    }, function (err) {
        console.error(err);
    });
})();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?php
/**
 * Example for Subaccount list
 */
require 'vendor/autoload.php';
use vts\RestClient;
use vts\Exceptions\VTSRestException;
$client = new RestClient("<auth_id>","<auth_token>");

try {
    $response = $client->subaccounts->list(
        3,
        2
    );
    print_r($response);
}
catch (VTSRestException $ex) {
    print_r($ex);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package net.vtscom.api.samples.subaccount;

import java.io.IOException;
import net.vtscom.api.VTS;
import net.vtscom.api.exceptions.PlivoRestException;
import net.vtscom.api.models.account.Subaccount;
import net.vtscom.api.models.base.ListResponse;

/**
* Example for Subaccount list
*/
class SubaccountList {
    public static void main(String [] args) {
        vts.init("<auth_id>","<auth_token>");
        try {
            ListResponse<Subaccount> response = Subaccount.lister()
                .offset(0)
                .limit(5)
                .list();

            System.out.println(response);
        } catch (VTSRestException | IOException e) {
            e.printStackTrace();
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
 * Example for Subaccount List
 */
using System;
using System.Collections.Generic;
using vts;
using vts.Exception;

namespace VTSExamples
{
    internal class Program
    {
        public static void Main(string[] args)
        {
            var api = new VTSApi("<auth_id>","<auth_token>");
            try
            {
                var response = api.Subaccount.List(
                    limit:5,
                    offset:0
                );
                Console.WriteLine(response);
            }
            catch (VTSRestException e)
            {
                Console.WriteLine("Exception: " + e.Message);
            }
        }
    }
}
1
2
curl -i --user AUTH_ID:AUTH_TOKEN \
    https://api.vtscom.net/v1/Account/{auth_id}/Subaccount/
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Example for Subaccount list
package main

import (
	"fmt"

	"github.com/vts/vts-go/v7"
)

func main() {
	client, err := vts.NewClient("<auth_id>", "<auth_token>", &vts.ClientOptions{})
	if err != nil {
		fmt.Print("Error", err.Error())
		return
	}
	response, err := client.Subaccounts.List(
		vts.SubaccountListParams{
			Offset: 0,
			Limit:  5,
		},
	)
	if err != nil {
		fmt.Print("Error", err.Error())
		return
	}
	fmt.Printf("Response: %#v\n", response)
}