PureBasic / Zoom API / List sub accounts
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(queryParams,"page_size",30)
CkJsonObject::ckUpdateInt(queryParams,"page_number",1)
CkJsonObject::ckUpdateString(queryParams,"next_page_token","quis officia in reprehenderit")
CkJsonObject::ckUpdateString(queryParams,"sub_reseller_id","quis officia in reprehenderit")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.zoom.us/v2/accounts",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
id.s
account_name.s
owner_email.s
account_type.s
seats.s
subscription_start_time.s
subscription_end_time.s
created_at.s
page_count.s = CkJsonObject::ckStringOf(jResp,"page_count")
page_number.s = CkJsonObject::ckStringOf(jResp,"page_number")
page_size.s = CkJsonObject::ckStringOf(jResp,"page_size")
total_records.s = CkJsonObject::ckStringOf(jResp,"total_records")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"accounts")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"accounts[i].id")
account_name = CkJsonObject::ckStringOf(jResp,"accounts[i].account_name")
owner_email = CkJsonObject::ckStringOf(jResp,"accounts[i].owner_email")
account_type = CkJsonObject::ckStringOf(jResp,"accounts[i].account_type")
seats = CkJsonObject::ckStringOf(jResp,"accounts[i].seats")
subscription_start_time = CkJsonObject::ckStringOf(jResp,"accounts[i].subscription_start_time")
subscription_end_time = CkJsonObject::ckStringOf(jResp,"accounts[i].subscription_end_time")
created_at = CkJsonObject::ckStringOf(jResp,"accounts[i].created_at")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
