Chilkat Online Tools

unicodeC / Zoom API / List users

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *id;
    const wchar_t *first_name;
    const wchar_t *last_name;
    const wchar_t *email;
    int v_type;
    int pmi;
    const wchar_t *timezone;
    int verified;
    const wchar_t *dept;
    const wchar_t *created_at;
    const wchar_t *last_login_time;
    const wchar_t *last_client_version;
    const wchar_t *pic_url;
    const wchar_t *status;
    const wchar_t *employee_unique_id;
    int j;
    int count_j;
    const wchar_t *strVal;
    int page_count;
    int page_number;
    int page_size;
    int total_records;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(queryParams,L"status",L"active");
    CkJsonObjectW_UpdateInt(queryParams,L"page_size",30);
    CkJsonObjectW_UpdateString(queryParams,L"role_id",L"quis officia in reprehenderit");
    CkJsonObjectW_UpdateString(queryParams,L"page_number",L"quis officia in reprehenderit");
    CkJsonObjectW_UpdateString(queryParams,L"include_fields",L"custom_attributes");
    CkJsonObjectW_UpdateString(queryParams,L"next_page_token",L"quis officia in reprehenderit");

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.zoom.us/v2/users",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    page_count = CkJsonObjectW_IntOf(jResp,L"page_count");
    page_number = CkJsonObjectW_IntOf(jResp,L"page_number");
    page_size = CkJsonObjectW_IntOf(jResp,L"page_size");
    total_records = CkJsonObjectW_IntOf(jResp,L"total_records");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"users");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        id = CkJsonObjectW_stringOf(jResp,L"users[i].id");
        first_name = CkJsonObjectW_stringOf(jResp,L"users[i].first_name");
        last_name = CkJsonObjectW_stringOf(jResp,L"users[i].last_name");
        email = CkJsonObjectW_stringOf(jResp,L"users[i].email");
        v_type = CkJsonObjectW_IntOf(jResp,L"users[i].type");
        pmi = CkJsonObjectW_IntOf(jResp,L"users[i].pmi");
        timezone = CkJsonObjectW_stringOf(jResp,L"users[i].timezone");
        verified = CkJsonObjectW_IntOf(jResp,L"users[i].verified");
        dept = CkJsonObjectW_stringOf(jResp,L"users[i].dept");
        created_at = CkJsonObjectW_stringOf(jResp,L"users[i].created_at");
        last_login_time = CkJsonObjectW_stringOf(jResp,L"users[i].last_login_time");
        last_client_version = CkJsonObjectW_stringOf(jResp,L"users[i].last_client_version");
        pic_url = CkJsonObjectW_stringOf(jResp,L"users[i].pic_url");
        status = CkJsonObjectW_stringOf(jResp,L"users[i].status");
        employee_unique_id = CkJsonObjectW_stringOf(jResp,L"users[i].employee_unique_id");
        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"users[i].im_group_ids");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            strVal = CkJsonObjectW_stringOf(jResp,L"users[i].im_group_ids[j]");
            j = j + 1;
        }

        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

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