Chilkat Online Tools

Python / Zoom API / List users

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

queryParams = chilkat.CkJsonObject()
queryParams.UpdateString("status","active")
queryParams.UpdateInt("page_size",30)
queryParams.UpdateString("role_id","quis officia in reprehenderit")
queryParams.UpdateString("page_number","quis officia in reprehenderit")
queryParams.UpdateString("include_fields","custom_attributes")
queryParams.UpdateString("next_page_token","quis officia in reprehenderit")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/users",queryParams)
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

print("Response Body:")
print(jResp.emit())

respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.header())
    print("Failed.")

    sys.exit()

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "page_count": 1,
#   "page_number": 1,
#   "page_size": 30,
#   "total_records": 1,
#   "users": [
#     {
#       "id": "z8yAAAAA8bbbQ",
#       "first_name": "Taylor",
#       "last_name": "Kim",
#       "email": "example@example.com",
#       "type": 2,
#       "pmi": 111111111,
#       "timezone": "America/Los_Angeles",
#       "verified": 1,
#       "dept": "",
#       "created_at": "2018-11-15T01:10:08Z",
#       "last_login_time": "2019-09-13T21:08:52Z",
#       "last_client_version": "4.4.55383.0716(android)",
#       "pic_url": "https://example.com/photo.jpg",
#       "im_group_ids": [
#         "GroupName"
#       ],
#       "status": "active",
#       "employee_unique_id": "dddaaaa"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

page_count = jResp.IntOf("page_count")
page_number = jResp.IntOf("page_number")
page_size = jResp.IntOf("page_size")
total_records = jResp.IntOf("total_records")
i = 0
count_i = jResp.SizeOfArray("users")
while i < count_i :
    jResp.put_I(i)
    id = jResp.stringOf("users[i].id")
    first_name = jResp.stringOf("users[i].first_name")
    last_name = jResp.stringOf("users[i].last_name")
    email = jResp.stringOf("users[i].email")
    v_type = jResp.IntOf("users[i].type")
    pmi = jResp.IntOf("users[i].pmi")
    timezone = jResp.stringOf("users[i].timezone")
    verified = jResp.IntOf("users[i].verified")
    dept = jResp.stringOf("users[i].dept")
    created_at = jResp.stringOf("users[i].created_at")
    last_login_time = jResp.stringOf("users[i].last_login_time")
    last_client_version = jResp.stringOf("users[i].last_client_version")
    pic_url = jResp.stringOf("users[i].pic_url")
    status = jResp.stringOf("users[i].status")
    employee_unique_id = jResp.stringOf("users[i].employee_unique_id")
    j = 0
    count_j = jResp.SizeOfArray("users[i].im_group_ids")
    while j < count_j :
        jResp.put_J(j)
        strVal = jResp.stringOf("users[i].im_group_ids[j]")
        j = j + 1

    i = i + 1

Curl Command

curl -G -d "status=active"
	-d "page_size=30"
	-d "role_id=quis%20officia%20in%20reprehenderit"
	-d "page_number=quis%20officia%20in%20reprehenderit"
	-d "include_fields=custom_attributes"
	-d "next_page_token=quis%20officia%20in%20reprehenderit"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users

Postman Collection Item JSON

{
  "name": "List users",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/users?status=active&page_size=30&role_id=quis officia in reprehenderit&page_number=quis officia in reprehenderit&include_fields=custom_attributes&next_page_token=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "users"
      ],
      "query": [
        {
          "key": "status",
          "value": "active",
          "description": "The user's status: \n* `active` — An active user. \n* `inactive` — A deactivated user. \n* `pending` — A pending user.\n\nThis value defaults to `active`."
        },
        {
          "key": "page_size",
          "value": "30",
          "description": "The number of records returned within a single API call."
        },
        {
          "key": "role_id",
          "value": "quis officia in reprehenderit",
          "description": "The role's unique ID. Use this parameter to filter the response by a specific role. You can use the [List Roles](https://marketplace.zoom.us/docs/api-reference/zoom-api/roles/roles) API to get a role's unique ID value."
        },
        {
          "key": "page_number",
          "value": "quis officia in reprehenderit",
          "description": "The page number of the current page in the returned records."
        },
        {
          "key": "include_fields",
          "value": "custom_attributes",
          "description": "Use this parameter to display one of the following attributes in the API call's response: \n* `custom_attributes` — Return the user's custom attributes. \n* `host_key` — Return the user's [host key](https://support.zoom.us/hc/en-us/articles/205172555-Using-your-host-key)."
        },
        {
          "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."
        }
      ]
    },
    "description": "Use this API to list your account's users. \n\n**Scopes:** `user:read:admin` \n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nUser list returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/users?status=active&page_size=30&role_id=quis officia in reprehenderit&page_number=quis officia in reprehenderit&include_fields=custom_attributes&next_page_token=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "users"
          ],
          "query": [
            {
              "key": "status",
              "value": "active"
            },
            {
              "key": "page_size",
              "value": "30"
            },
            {
              "key": "role_id",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "page_number",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "include_fields",
              "value": "custom_attributes"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 30,\n \"total_records\": 1,\n \"users\": [\n  {\n   \"id\": \"z8yAAAAA8bbbQ\",\n   \"first_name\": \"Taylor\",\n   \"last_name\": \"Kim\",\n   \"email\": \"example@example.com\",\n   \"type\": 2,\n   \"pmi\": 111111111,\n   \"timezone\": \"America/Los_Angeles\",\n   \"verified\": 1,\n   \"dept\": \"\",\n   \"created_at\": \"2018-11-15T01:10:08Z\",\n   \"last_login_time\": \"2019-09-13T21:08:52Z\",\n   \"last_client_version\": \"4.4.55383.0716(android)\",\n   \"pic_url\": \"https://example.com/photo.jpg\",\n   \"im_group_ids\": [\n    \"GroupName\"\n   ],\n   \"status\": \"active\",\n   \"employee_unique_id\": \"dddaaaa\"\n  }\n ]\n}"
    }
  ]
}