PowerBuilder / Zoom API / List sub accounts
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Account_name
string ls_Owner_email
string ls_Account_type
string ls_Seats
string ls_Subscription_start_time
string ls_Subscription_end_time
string ls_Created_at
string ls_Page_count
string ls_Page_number
string ls_Page_size
string ls_Total_records
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateInt("page_size",30)
loo_QueryParams.UpdateInt("page_number",1)
loo_QueryParams.UpdateString("next_page_token","quis officia in reprehenderit")
loo_QueryParams.UpdateString("sub_reseller_id","quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.zoom.us/v2/accounts",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page_count": "integer",
// "page_number": "integer",
// "page_size": "integer",
// "total_records": "integer",
// "accounts": [
// {
// "id": "string [uuid]",
// "account_name": "string",
// "owner_email": "string",
// "account_type": "string",
// "seats": "integer",
// "subscription_start_time": "string [date-time]",
// "subscription_end_time": "string [date-time]",
// "created_at": "string [date-time]"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Page_count = loo_JResp.StringOf("page_count")
ls_Page_number = loo_JResp.StringOf("page_number")
ls_Page_size = loo_JResp.StringOf("page_size")
ls_Total_records = loo_JResp.StringOf("total_records")
i = 0
li_Count_i = loo_JResp.SizeOfArray("accounts")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("accounts[i].id")
ls_Account_name = loo_JResp.StringOf("accounts[i].account_name")
ls_Owner_email = loo_JResp.StringOf("accounts[i].owner_email")
ls_Account_type = loo_JResp.StringOf("accounts[i].account_type")
ls_Seats = loo_JResp.StringOf("accounts[i].seats")
ls_Subscription_start_time = loo_JResp.StringOf("accounts[i].subscription_start_time")
ls_Subscription_end_time = loo_JResp.StringOf("accounts[i].subscription_end_time")
ls_Created_at = loo_JResp.StringOf("accounts[i].created_at")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "page_size=30"
-d "page_number=1"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-d "sub_reseller_id=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts
Postman Collection Item JSON
{
"name": "List sub accounts",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/accounts?page_size=30&page_number=1&next_page_token=quis officia in reprehenderit&sub_reseller_id=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts"
],
"query": [
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "page_number",
"value": "1",
"description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
},
{
"key": "sub_reseller_id",
"value": "quis officia in reprehenderit",
"description": "The sub-reseller's ID. \n\n If you use this query parameter, the API returns all the sub accounts created by the sub-reseller account."
}
]
},
"description": "List all the sub accounts that have been created by a master account.<br><br>Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts. Email the partner programs team at **partner-success@zoom.us** for more details.\n\n<br>**Prerequisites:**<br>\n* Pro or a higher paid account with master account option enabled. <br>\n\n**Scope**: `account:read:admin`\n<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>\n\n"
},
"response": [
{
"name": "Account list returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts?page_size=30&page_number=1&next_page_token=quis officia in reprehenderit&sub_reseller_id=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts"
],
"query": [
{
"key": "page_size",
"value": "30"
},
{
"key": "page_number",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
},
{
"key": "sub_reseller_id",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page_count\": \"integer\",\n \"page_number\": \"integer\",\n \"page_size\": \"integer\",\n \"total_records\": \"integer\",\n \"accounts\": [\n {\n \"id\": \"string [uuid]\",\n \"account_name\": \"string\",\n \"owner_email\": \"string\",\n \"account_type\": \"string\",\n \"seats\": \"integer\",\n \"subscription_start_time\": \"string [date-time]\",\n \"subscription_end_time\": \"string [date-time]\",\n \"created_at\": \"string [date-time]\"\n }\n ]\n}"
}
]
}
