Chilkat Tools

delphiDll / Support API / Search Users

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
name: PWideChar;
active: PWideChar;
alias: PWideChar;
chat_only: PWideChar;
created_at: PWideChar;
custom_role_id: PWideChar;
default_group_id: PWideChar;
details: PWideChar;
email: PWideChar;
external_id: PWideChar;
iana_time_zone: PWideChar;
id: PWideChar;
last_login_at: PWideChar;
locale: PWideChar;
locale_id: PWideChar;
moderator: PWideChar;
notes: PWideChar;
only_private_comments: PWideChar;
organization_id: PWideChar;
phone: PWideChar;
In1f: Boolean;
Cillumb5: Boolean;
remote_photo_url: PWideChar;
report_csv: PWideChar;
restricted_agent: PWideChar;
role: PWideChar;
role_type: PWideChar;
v_shared: PWideChar;
shared_agent: PWideChar;
shared_phone_number: PWideChar;
signature: PWideChar;
suspended: PWideChar;
tags: PWideChar;
ticket_restriction: PWideChar;
time_zone: PWideChar;
two_factor_auth_enabled: PWideChar;
updated_at: PWideChar;
url: PWideChar;
Nisi_e: PWideChar;
verified: PWideChar;
Ut69: Boolean;
Magna_4: Integer;
Loremcc: Integer;
Dolore7: Boolean;
Pariaturf: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'query','<string>');
CkJsonObject_UpdateString(queryParams,'external_id','<string>');

CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequestParams(http,'GET','https://example.zendesk.com/api/v2/users/search',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(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

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'users');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    name := CkJsonObject__stringOf(jResp,'users[i].name');
    active := CkJsonObject__stringOf(jResp,'users[i].active');
    alias := CkJsonObject__stringOf(jResp,'users[i].alias');
    chat_only := CkJsonObject__stringOf(jResp,'users[i].chat_only');
    created_at := CkJsonObject__stringOf(jResp,'users[i].created_at');
    custom_role_id := CkJsonObject__stringOf(jResp,'users[i].custom_role_id');
    default_group_id := CkJsonObject__stringOf(jResp,'users[i].default_group_id');
    details := CkJsonObject__stringOf(jResp,'users[i].details');
    email := CkJsonObject__stringOf(jResp,'users[i].email');
    external_id := CkJsonObject__stringOf(jResp,'users[i].external_id');
    iana_time_zone := CkJsonObject__stringOf(jResp,'users[i].iana_time_zone');
    id := CkJsonObject__stringOf(jResp,'users[i].id');
    last_login_at := CkJsonObject__stringOf(jResp,'users[i].last_login_at');
    locale := CkJsonObject__stringOf(jResp,'users[i].locale');
    locale_id := CkJsonObject__stringOf(jResp,'users[i].locale_id');
    moderator := CkJsonObject__stringOf(jResp,'users[i].moderator');
    notes := CkJsonObject__stringOf(jResp,'users[i].notes');
    only_private_comments := CkJsonObject__stringOf(jResp,'users[i].only_private_comments');
    organization_id := CkJsonObject__stringOf(jResp,'users[i].organization_id');
    phone := CkJsonObject__stringOf(jResp,'users[i].phone');
    In1f := CkJsonObject_BoolOf(jResp,'users[i].photo.in1f');
    Cillumb5 := CkJsonObject_BoolOf(jResp,'users[i].photo.cillumb5');
    remote_photo_url := CkJsonObject__stringOf(jResp,'users[i].remote_photo_url');
    report_csv := CkJsonObject__stringOf(jResp,'users[i].report_csv');
    restricted_agent := CkJsonObject__stringOf(jResp,'users[i].restricted_agent');
    role := CkJsonObject__stringOf(jResp,'users[i].role');
    role_type := CkJsonObject__stringOf(jResp,'users[i].role_type');
    v_shared := CkJsonObject__stringOf(jResp,'users[i].shared');
    shared_agent := CkJsonObject__stringOf(jResp,'users[i].shared_agent');
    shared_phone_number := CkJsonObject__stringOf(jResp,'users[i].shared_phone_number');
    signature := CkJsonObject__stringOf(jResp,'users[i].signature');
    suspended := CkJsonObject__stringOf(jResp,'users[i].suspended');
    tags := CkJsonObject__stringOf(jResp,'users[i].tags');
    ticket_restriction := CkJsonObject__stringOf(jResp,'users[i].ticket_restriction');
    time_zone := CkJsonObject__stringOf(jResp,'users[i].time_zone');
    two_factor_auth_enabled := CkJsonObject__stringOf(jResp,'users[i].two_factor_auth_enabled');
    updated_at := CkJsonObject__stringOf(jResp,'users[i].updated_at');
    url := CkJsonObject__stringOf(jResp,'users[i].url');
    Nisi_e := CkJsonObject__stringOf(jResp,'users[i].user_fields.nisi_e');
    verified := CkJsonObject__stringOf(jResp,'users[i].verified');
    Ut69 := CkJsonObject_BoolOf(jResp,'users[i].photo.ut69');
    Magna_4 := CkJsonObject_IntOf(jResp,'users[i].photo.magna_4');
    Loremcc := CkJsonObject_IntOf(jResp,'users[i].user_fields.Loremcc');
    Dolore7 := CkJsonObject_BoolOf(jResp,'users[i].user_fields.dolore7');
    Pariaturf := CkJsonObject__stringOf(jResp,'users[i].user_fields.pariaturf');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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

Chilkat Online Tools

delphiDll / Support API / Search Users

Curl Command

Postman Collection Item JSON