Chilkat Online Tools

Swift / Zoom API / List sub accounts

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateInt("page_size", value: 30)
    queryParams.UpdateInt("page_number", value: 1)
    queryParams.UpdateString("next_page_token", value: "quis officia in reprehenderit")
    queryParams.UpdateString("sub_reseller_id", value: "quis officia in reprehenderit")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.AuthToken = "<access_token>"

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.zoom.us/v2/accounts", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var id: String?
    var account_name: String?
    var owner_email: String?
    var account_type: String?
    var seats: String?
    var subscription_start_time: String?
    var subscription_end_time: String?
    var created_at: String?

    var page_count: String? = jResp.StringOf("page_count")
    var page_number: String? = jResp.StringOf("page_number")
    var page_size: String? = jResp.StringOf("page_size")
    var total_records: String? = jResp.StringOf("total_records")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("accounts").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.StringOf("accounts[i].id")
        account_name = jResp.StringOf("accounts[i].account_name")
        owner_email = jResp.StringOf("accounts[i].owner_email")
        account_type = jResp.StringOf("accounts[i].account_type")
        seats = jResp.StringOf("accounts[i].seats")
        subscription_start_time = jResp.StringOf("accounts[i].subscription_start_time")
        subscription_end_time = jResp.StringOf("accounts[i].subscription_end_time")
        created_at = jResp.StringOf("accounts[i].created_at")
        i = i + 1
    }


}

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}"
    }
  ]
}