Chilkat Online Tools

VB.NET / Plivo REST API / List all Subaccounts

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "{{auth_id}}"
http.Password = "password"

Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateInt("limit",5)
queryParams.UpdateInt("offset",0)



Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://api.plivo.com/v1/Account/<auth_id>/Subaccount/",queryParams)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)

Curl Command

curl -G -d "limit=5"
	-d "offset=0"
	-u '{{auth_id}}:password'
https://api.plivo.com/v1/Account/<auth_id>/Subaccount/

Postman Collection Item JSON

{
  "name": "List all Subaccounts",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Subaccount/?limit=5&offset=0",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Subaccount",
        ""
      ],
      "query": [
        {
          "key": "limit",
          "value": "5",
          "description": "Used to display the number of results per page. The maximum number of results that can be fetched is 20"
        },
        {
          "key": "offset",
          "value": "0",
          "description": "Denotes the number of value items by which the results should be offset."
        }
      ]
    },
    "description": "Returns a list of subaccounts. The subaccounts are returned sorted by creation date, with the most recently created subaccount appearing first.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/account/api/subaccount#list-all-subaccounts)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| limit      | Used to display the number of results per page. The maximum number of results that can be fetched is 20.| Optional  |\n| offset   | Denotes the number of value items by which the results should be offset | Optional |"
  },
  "response": [
    {
      "name": "List all Subaccounts",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Subaccount/?limit=5&offset=0",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Subaccount",
            ""
          ],
          "query": [
            {
              "key": "limit",
              "value": "5",
              "description": "Used to display the number of results per page. The maximum number of results that can be fetched is 20"
            },
            {
              "key": "offset",
              "value": "0",
              "description": "Denotes the number of value items by which the results should be offset."
            }
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"b38bf42e-0db4-11e4-8a4a-123140008edf\",\n    \"meta\": {\n        \"limit\": 20,\n        \"next\": null,\n        \"offset\": 0,\n        \"previous\": null,\n        \"total_count\": 2\n    },\n    \"objects\": [\n        {\n            \"account\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/\",\n            \"auth_id\": \"SAXXXXXXXXXXXXXXXXXX\",\n            \"auth_token\": \"MTZjYWM0YzVjNjMwZmVmODFiNWJjNWJmOGJjZjgw\",\n            \"created\": \"2014-07-17\",\n            \"enabled\": false,\n            \"modified\": null,\n            \"name\": \"Chewbacca\",\n            \"resource_uri\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Subaccount/SAXXXXXXXXXXXXXXXXXX/\"\n        },\n        {\n            \"account\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/\",\n            \"auth_id\": \"SAXXXXXXXXXXXXXXXXXX\",\n            \"auth_token\": \"OTdhMjYwMWYxOGMyNpFjNzUwYWM3YWI3NjY4Y2Ey\",\n            \"created\": \"2012-09-23\",\n            \"enabled\": true,\n            \"modified\": \"2012-09-23\",\n            \"name\": \"new\",\n            \"resource_uri\": \"/v1/Account/MAXXXXXXXXXXXXXXXXXX/Subaccount/SAXXXXXXXXXXXXXXXXXX/\"\n        }\n    ]\n}"
    }
  ]
}