Chilkat Online Tools

unicodeCpp / Support API / Search Users

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>

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

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"login");
    http.put_Password(L"password");

    CkJsonObjectW queryParams;
    queryParams.UpdateString(L"query",L"<string>");
    queryParams.UpdateString(L"external_id",L"<string>");

    http.SetRequestHeader(L"Accept",L"application/json");

    CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://example.zendesk.com/api/v2/users/search",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

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

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "users": [
    //     {
    //       "name": "<string>",
    //       "active": "<boolean>",
    //       "alias": "<string>",
    //       "chat_only": "<boolean>",
    //       "created_at": "<string>",
    //       "custom_role_id": "<integer>",
    //       "default_group_id": "<integer>",
    //       "details": "<string>",
    //       "email": "<string>",
    //       "external_id": "<string>",
    //       "iana_time_zone": "<string>",
    //       "id": "<integer>",
    //       "last_login_at": "<string>",
    //       "locale": "<string>",
    //       "locale_id": "<integer>",
    //       "moderator": "<boolean>",
    //       "notes": "<string>",
    //       "only_private_comments": "<boolean>",
    //       "organization_id": "<integer>",
    //       "phone": "<string>",
    //       "photo": {
    //         "in1f": false,
    //         "cillumb5": true
    //       },
    //       "remote_photo_url": "<string>",
    //       "report_csv": "<boolean>",
    //       "restricted_agent": "<boolean>",
    //       "role": "<string>",
    //       "role_type": "<integer>",
    //       "shared": "<boolean>",
    //       "shared_agent": "<boolean>",
    //       "shared_phone_number": "<boolean>",
    //       "signature": "<string>",
    //       "suspended": "<boolean>",
    //       "tags": "<array>",
    //       "ticket_restriction": "<string>",
    //       "time_zone": "<string>",
    //       "two_factor_auth_enabled": "<boolean>",
    //       "updated_at": "<string>",
    //       "url": "<string>",
    //       "user_fields": {
    //         "nisi_e": "commodo exercitation consequat"
    //       },
    //       "verified": "<boolean>"
    //     },
    //     {
    //       "name": "<string>",
    //       "active": "<boolean>",
    //       "alias": "<string>",
    //       "chat_only": "<boolean>",
    //       "created_at": "<string>",
    //       "custom_role_id": "<integer>",
    //       "default_group_id": "<integer>",
    //       "details": "<string>",
    //       "email": "<string>",
    //       "external_id": "<string>",
    //       "iana_time_zone": "<string>",
    //       "id": "<integer>",
    //       "last_login_at": "<string>",
    //       "locale": "<string>",
    //       "locale_id": "<integer>",
    //       "moderator": "<boolean>",
    //       "notes": "<string>",
    //       "only_private_comments": "<boolean>",
    //       "organization_id": "<integer>",
    //       "phone": "<string>",
    //       "photo": {
    //         "ut69": true,
    //         "magna_4": -92520384
    //       },
    //       "remote_photo_url": "<string>",
    //       "report_csv": "<boolean>",
    //       "restricted_agent": "<boolean>",
    //       "role": "<string>",
    //       "role_type": "<integer>",
    //       "shared": "<boolean>",
    //       "shared_agent": "<boolean>",
    //       "shared_phone_number": "<boolean>",
    //       "signature": "<string>",
    //       "suspended": "<boolean>",
    //       "tags": "<array>",
    //       "ticket_restriction": "<string>",
    //       "time_zone": "<string>",
    //       "two_factor_auth_enabled": "<boolean>",
    //       "updated_at": "<string>",
    //       "url": "<string>",
    //       "user_fields": {
    //         "Loremcc": 52379422,
    //         "dolore7": true,
    //         "pariaturf": "magna consectet"
    //       },
    //       "verified": "<boolean>"
    //     }
    //   ]
    // }

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

    const wchar_t *name = 0;
    const wchar_t *active = 0;
    const wchar_t *alias = 0;
    const wchar_t *chat_only = 0;
    const wchar_t *created_at = 0;
    const wchar_t *custom_role_id = 0;
    const wchar_t *default_group_id = 0;
    const wchar_t *details = 0;
    const wchar_t *email = 0;
    const wchar_t *external_id = 0;
    const wchar_t *iana_time_zone = 0;
    const wchar_t *id = 0;
    const wchar_t *last_login_at = 0;
    const wchar_t *locale = 0;
    const wchar_t *locale_id = 0;
    const wchar_t *moderator = 0;
    const wchar_t *notes = 0;
    const wchar_t *only_private_comments = 0;
    const wchar_t *organization_id = 0;
    const wchar_t *phone = 0;
    bool In1f;
    bool Cillumb5;
    const wchar_t *remote_photo_url = 0;
    const wchar_t *report_csv = 0;
    const wchar_t *restricted_agent = 0;
    const wchar_t *role = 0;
    const wchar_t *role_type = 0;
    const wchar_t *v_shared = 0;
    const wchar_t *shared_agent = 0;
    const wchar_t *shared_phone_number = 0;
    const wchar_t *signature = 0;
    const wchar_t *suspended = 0;
    const wchar_t *tags = 0;
    const wchar_t *ticket_restriction = 0;
    const wchar_t *time_zone = 0;
    const wchar_t *two_factor_auth_enabled = 0;
    const wchar_t *updated_at = 0;
    const wchar_t *url = 0;
    const wchar_t *Nisi_e = 0;
    const wchar_t *verified = 0;
    bool Ut69;
    int Magna_4;
    int Loremcc;
    bool Dolore7;
    const wchar_t *Pariaturf = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray(L"users");
    while (i < count_i) {
        jResp.put_I(i);
        name = jResp.stringOf(L"users[i].name");
        active = jResp.stringOf(L"users[i].active");
        alias = jResp.stringOf(L"users[i].alias");
        chat_only = jResp.stringOf(L"users[i].chat_only");
        created_at = jResp.stringOf(L"users[i].created_at");
        custom_role_id = jResp.stringOf(L"users[i].custom_role_id");
        default_group_id = jResp.stringOf(L"users[i].default_group_id");
        details = jResp.stringOf(L"users[i].details");
        email = jResp.stringOf(L"users[i].email");
        external_id = jResp.stringOf(L"users[i].external_id");
        iana_time_zone = jResp.stringOf(L"users[i].iana_time_zone");
        id = jResp.stringOf(L"users[i].id");
        last_login_at = jResp.stringOf(L"users[i].last_login_at");
        locale = jResp.stringOf(L"users[i].locale");
        locale_id = jResp.stringOf(L"users[i].locale_id");
        moderator = jResp.stringOf(L"users[i].moderator");
        notes = jResp.stringOf(L"users[i].notes");
        only_private_comments = jResp.stringOf(L"users[i].only_private_comments");
        organization_id = jResp.stringOf(L"users[i].organization_id");
        phone = jResp.stringOf(L"users[i].phone");
        In1f = jResp.BoolOf(L"users[i].photo.in1f");
        Cillumb5 = jResp.BoolOf(L"users[i].photo.cillumb5");
        remote_photo_url = jResp.stringOf(L"users[i].remote_photo_url");
        report_csv = jResp.stringOf(L"users[i].report_csv");
        restricted_agent = jResp.stringOf(L"users[i].restricted_agent");
        role = jResp.stringOf(L"users[i].role");
        role_type = jResp.stringOf(L"users[i].role_type");
        v_shared = jResp.stringOf(L"users[i].shared");
        shared_agent = jResp.stringOf(L"users[i].shared_agent");
        shared_phone_number = jResp.stringOf(L"users[i].shared_phone_number");
        signature = jResp.stringOf(L"users[i].signature");
        suspended = jResp.stringOf(L"users[i].suspended");
        tags = jResp.stringOf(L"users[i].tags");
        ticket_restriction = jResp.stringOf(L"users[i].ticket_restriction");
        time_zone = jResp.stringOf(L"users[i].time_zone");
        two_factor_auth_enabled = jResp.stringOf(L"users[i].two_factor_auth_enabled");
        updated_at = jResp.stringOf(L"users[i].updated_at");
        url = jResp.stringOf(L"users[i].url");
        Nisi_e = jResp.stringOf(L"users[i].user_fields.nisi_e");
        verified = jResp.stringOf(L"users[i].verified");
        Ut69 = jResp.BoolOf(L"users[i].photo.ut69");
        Magna_4 = jResp.IntOf(L"users[i].photo.magna_4");
        Loremcc = jResp.IntOf(L"users[i].user_fields.Loremcc");
        Dolore7 = jResp.BoolOf(L"users[i].user_fields.dolore7");
        Pariaturf = jResp.stringOf(L"users[i].user_fields.pariaturf");
        i = i + 1;
    }
    }

Curl Command

curl  -u login:password -G -d "query=%3Cstring%3E"
	-d "external_id=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/search

Postman Collection Item JSON

{
  "name": "Search Users",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/search?query=<string>&external_id=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        "search"
      ],
      "query": [
        {
          "key": "query",
          "value": "<string>",
          "description": "The `query` parameter supports the Zendesk search syntax for more advanced\nuser searches. It can specify a partial or full value of any\nuser property, including name, email address, notes, or phone. Example:\n`query=\"jdoe\"`.\nSee the [Search API](/api-reference/ticketing/ticket-management/search/).\n"
        },
        {
          "key": "external_id",
          "value": "<string>",
          "description": "The `external_id` parameter does not support the search syntax. It only accepts ids.\n"
        }
      ]
    },
    "description": "Returns an array of users who meet the search criteria.\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\n#### Allowed For\n\n* Admins, Agents and Light Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/users/search?query=<string>&external_id=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            "search"
          ],
          "query": [
            {
              "key": "query",
              "value": "<string>",
              "description": "The `query` parameter supports the Zendesk search syntax for more advanced\nuser searches. It can specify a partial or full value of any\nuser property, including name, email address, notes, or phone. Example:\n`query=\"jdoe\"`.\nSee the [Search API](/api-reference/ticketing/ticket-management/search/).\n"
            },
            {
              "key": "external_id",
              "value": "<string>",
              "description": "The `external_id` parameter does not support the search syntax. It only accepts ids.\n"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"users\": [\n    {\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"alias\": \"<string>\",\n      \"chat_only\": \"<boolean>\",\n      \"created_at\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"default_group_id\": \"<integer>\",\n      \"details\": \"<string>\",\n      \"email\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"iana_time_zone\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"last_login_at\": \"<string>\",\n      \"locale\": \"<string>\",\n      \"locale_id\": \"<integer>\",\n      \"moderator\": \"<boolean>\",\n      \"notes\": \"<string>\",\n      \"only_private_comments\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"phone\": \"<string>\",\n      \"photo\": {\n        \"in1f\": false,\n        \"cillumb5\": true\n      },\n      \"remote_photo_url\": \"<string>\",\n      \"report_csv\": \"<boolean>\",\n      \"restricted_agent\": \"<boolean>\",\n      \"role\": \"<string>\",\n      \"role_type\": \"<integer>\",\n      \"shared\": \"<boolean>\",\n      \"shared_agent\": \"<boolean>\",\n      \"shared_phone_number\": \"<boolean>\",\n      \"signature\": \"<string>\",\n      \"suspended\": \"<boolean>\",\n      \"tags\": \"<array>\",\n      \"ticket_restriction\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"two_factor_auth_enabled\": \"<boolean>\",\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_fields\": {\n        \"nisi_e\": \"commodo exercitation consequat\"\n      },\n      \"verified\": \"<boolean>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"alias\": \"<string>\",\n      \"chat_only\": \"<boolean>\",\n      \"created_at\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"default_group_id\": \"<integer>\",\n      \"details\": \"<string>\",\n      \"email\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"iana_time_zone\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"last_login_at\": \"<string>\",\n      \"locale\": \"<string>\",\n      \"locale_id\": \"<integer>\",\n      \"moderator\": \"<boolean>\",\n      \"notes\": \"<string>\",\n      \"only_private_comments\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"phone\": \"<string>\",\n      \"photo\": {\n        \"ut69\": true,\n        \"magna_4\": -92520384\n      },\n      \"remote_photo_url\": \"<string>\",\n      \"report_csv\": \"<boolean>\",\n      \"restricted_agent\": \"<boolean>\",\n      \"role\": \"<string>\",\n      \"role_type\": \"<integer>\",\n      \"shared\": \"<boolean>\",\n      \"shared_agent\": \"<boolean>\",\n      \"shared_phone_number\": \"<boolean>\",\n      \"signature\": \"<string>\",\n      \"suspended\": \"<boolean>\",\n      \"tags\": \"<array>\",\n      \"ticket_restriction\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"two_factor_auth_enabled\": \"<boolean>\",\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_fields\": {\n        \"Loremcc\": 52379422,\n        \"dolore7\": true,\n        \"pariaturf\": \"magna consectet\"\n      },\n      \"verified\": \"<boolean>\"\n    }\n  ]\n}"
    }
  ]
}